[jira] [Resolved] (OAK-5520) Improve index and query documentation

["Thomas Mueller (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/OAK-5520?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Thomas Mueller resolved OAK-5520.
---------------------------------
    Resolution: Fixed

I consider this fixed for now (see also query grammar documentation). No need to keep it open.

> Improve index and query documentation
> -------------------------------------
>
>                 Key: OAK-5520
>                 URL: https://issues.apache.org/jira/browse/OAK-5520
>             Project: Jackrabbit Oak
>          Issue Type: Documentation
>          Components: lucene, query
>            Reporter: Thomas Mueller
>            Assignee: Thomas Mueller
>            Priority: Major
>             Fix For: 1.10
>
>
> The Oak index and query documentation needs to be improved:
> * step-by-step descriptions of how to fix problems (for example from slow queries to fast queries)
> * checklists
> * index corruption vs merely _perceive_ corruption
> * checkpoints
> * text extraction
> * link to tools, such as the Oak Lucene Index Definition Generator at http://oakutils.appspot.com/generate/index
> * indexing and reindex: when it is needed and how to do it, how long does it take, how to stop
> * document currently undocumented features (for example Lucene index, notNullCheckEnabled)



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)