[OAK-5520] Improve index and query documentation

• Type: Documentation
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.10.0
• Component/s: lucene, query
• Epic Link: indexer resilience
• Assignee: Thomas Mueller
• Reporter: Thomas Mueller
• Created: 26/Jan/17 08:12
• Updated: 16/Jan/19 11:41
• Resolved: 08/Mar/18 14:45

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)

Issue Links

• relates to: OAK-6217 Document tricky statements