[Apache Bloodhound] BloodhoundSearch modified

[Apache Bloodhound <bl...@incubator.apache.org>]

Page "BloodhoundSearch" was changed by andrej
Diff URL: <https://issues.apache.org/bloodhound/wiki/BloodhoundSearch?action=diff&version=2>
Revision 2
Changes:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: BloodhoundSearch
=========================================================================
--- BloodhoundSearch (version: 1)
+++ BloodhoundSearch (version: 2)
@@ -1,13 +1,63 @@
 = Bloodhound Search =
 
-== How to start==
- * enable bhsearch components in trac.ini file
+Current version is prototype phase 1. Read more about proposed functionality on [wiki:Proposals/BEP-0004 BEP-0004]
+
+== How to enable Bloodhound Search==
+ * enable bhsearch.* components in trac.ini file
 {{{
 [components]
 ...
 bhsearch.* = enabled
 }}}
- * run initial index rebuild using trac-admin command line tool.
+ * 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:
+* Free text search through indexed 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)"
+
+Currently, only tickets with the following fields are indexed. Later more resources and fields will be added.
+
+Common fields for all resources:
+ * id - resource id. For ticket it is ticket id, for wiki it will wiki name.
+ * type - resource type e.g. ticket, wiki etc.
+ * product - product name
+ * time - resource change time
+ * author - resource author. For ticket it is ticket reporter.
+ * content - ticket description
+ *changes - currently, only ticket comments are indexed
+
+Ticket specific fields:
+ * component
+ * status 
+ * resolution
+ * keywords
+ * 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 1 limitations == #limitations
+ * Only tickets are indexed. Wiki page indexing will be supported in near future.
+ * UI does not support faceting and type specific presentation i.e. All | Ticket | Wiki
+ * Search  does not support meta keywords 
+ * Possible bugs and inconveniences appropriate for expected phase 
+
+== 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 (wiki, milestones etc.), index more fields for ticket
+ * Improve search quality
+ * Improve index 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.
+ * A lot more things to do :)
-------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 .