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

Thomas Mueller updated OAK-5520:
--------------------------------
    Description: 
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)


  was:
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 missing features (for example Lucene index, notNullCheckEnabled)



> Improve index and query documentation
> -------------------------------------
>
>                 Key: OAK-5520
>                 URL: https://issues.apache.org/jira/browse/OAK-5520
>             Project: Jackrabbit Oak
>          Issue Type: Bug
>          Components: lucene, query
>            Reporter: Thomas Mueller
>            Assignee: Thomas Mueller
>             Fix For: 1.7.0
>
>
> 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
(v6.3.4#6332)

Reply via email to