incubator-bloodhound-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Apache Bloodhound" <bloodhound-...@incubator.apache.org>
Subject [Apache Bloodhound] BloodhoundSearch modified
Date Thu, 24 Jan 2013 14:03:15 GMT
Page "BloodhoundSearch" was changed by andrej
Diff URL: <https://issues.apache.org/bloodhound/wiki/BloodhoundSearch?action=diff&version=9>
Revision 9
Changes:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: BloodhoundSearch
=========================================================================
--- BloodhoundSearch (version: 8)
+++ BloodhoundSearch (version: 9)
@@ -1,33 +1,39 @@
 = Bloodhound Search =
 
-Current version is prototype phase 1. Read more about proposed functionality on [wiki:Proposals/BEP-0004
BEP-0004]
+Bloodhound Search is currently in prototype phase. Read more about proposed functionality
on [wiki:Proposals/BEP-0004 BEP-0004]
 
 == How to enable Bloodhound Search==
- * Currently, Bloodhound Search is available only for dev configuration. Make sure that Bloodhound
was installed using requirements-dev.txt:
+ Currently, Bloodhound Search is available only for dev configuration. Make sure that Bloodhound
was installed using requirements-dev.txt:
 {{{
 pip install -r requirements-dev.txt
 }}}
- * enable bhsearch.* components in trac.ini file
+
+Enable bhsearch.* components in trac.ini file
 {{{
 [components]
 ...
 bhsearch.* = enabled
 }}}
- * run initial index rebuild using trac-admin command line tool. TODO: web interface should
be supported later
+
+Run initial index rebuild using trac-admin command line tool. TODO: web interface should
be supported later
 {{{
 trac-admin <path_to_trac_environment> bhsearch rebuild
 }}}
- * Bloodhound Search page will be available in Apps menu | Bloodhound Search
-
-== Search == #search
-Query syntax is described on wiki:Proposals/BEP-0004/ResourceQuery. Currently supported search
queries are: 
-* List of all items: "*"
-* Free text search through indexed fields e.g. "some text"
+ 
+== How to search == #search
+Click Apps menu and select Bloodhound Search item. You can search use free text search or
combine search with query syntax. Please consider below a few search samples: 
+* Free text search through multiple fields e.g. "some text"
 * Combination of free text and field specific query e.g. "test status:new keyword:starter"
(default operator is AND)
 * Field specific query e.g. "status:new keyword:starter" (default operator is AND)
 * Boolean queries e.g. "test OR (status:new and keyword:starter)"
+For more information on query syntax see wiki:Proposals/BEP-0004/ResourceQuery. 
 
-Currently, only tickets and wiki pages with the following fields are indexed. Later more
resources and fields will be added.
+Currently, you can search in tickets, wiki pages and milestones (later more resources will
be added). Use All | Ticket | Wiki | Milestone tabs to search entries of specific type.
+
+Bloodhound Search provides basic faceting functionality. Facets are specific for each resource
type. TODO: more complex faceting can be introduced e.g. date rages, pivot faces etc.
+
+== Supported fields
+Current version supports search in the following fields:
 
 Common fields for all resources:
  * id - resource id. For ticket it is ticket id, for wiki it will wiki page name.
@@ -46,26 +52,4 @@
  * milestone
  * summary
 
-Default sort order is by boost score ASC and time DESC
-
-Default query boosting is: id = 6, type = 2, summary = 5, author = 3, milestone = 2, keywords
= 2, component = 2, status = 2, content = 1, changes = 1, 
-
-== Prototype phase 2 limitations == #limitations
- * Only tickets and wiki pages are indexed.
- * UI does not support faceting
- * Search  does not support meta keywords 
- * Quick jump by ticket id and wiki name is not supported
- * Possible bugs and inconveniences expected for prototype 
-
-== To be done ==
-Please consider below not complete list of TODOs.
- * UI design for search results including facets and resource specific presentation. Initial
proposal can be found on [wiki:Proposals/BEP-0004#resultview BEP-0004]
- * Add facet support for search UI
- * Improve index quality e.d. add more resources in index (milestones etc.), index more fields
for ticket. Support pluggable schema generation.
- * Improve search quality
- * Improve index consistency. [=#consistency]  
-   * Current implementation uses ITicketChangeListener interface that triggers after DB committed.
There is some chances to get inconsistency between DB and index. In this case reindex is required.
One of the possible solution is contact Trac community to introduce a new within transaction
 I<Resource>ChangingListener interface, save changes into additional table and index
changes in separate thread.
-   * Some ticket changes are not reflected in event interfaces e.g. Version and Component
renaming. One of the possible solution is to contact Trac community to introduce new interfaces.
-   * Alternative solution is triggering events from SQL proxy developed on multi-product
branch
-   * Usage of DB triggers is another alternative
- * A lot more things to do :)
+By default, result output is sorted by relevance score and by resource time.
-------8<------8<------8<------8<------8<------8<------8<------8<--------

--
Page URL: <https://issues.apache.org/bloodhound/wiki/BloodhoundSearch>
Apache Bloodhound <https://issues.apache.org/bloodhound/>
The Apache Bloodhound (incubating) issue tracker

This is an automated message. Someone added your email address to be
notified of changes on 'BloodhoundSearch' page.
If it was not you, please report to .

Mime
View raw message