Uploaded image for project: 'Jackrabbit Oak'
  1. Jackrabbit Oak
  2. OAK-5520

Improve index and query documentation

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: Documentation
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.10.0
    • Component/s: lucene, query
    • Labels:
      None

      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)

        Attachments

        Issue Links

          Activity

            People

            • Assignee:
              thomasm Thomas Mueller
              Reporter:
              thomasm Thomas Mueller

              Dates

              • Created:
                Updated:
                Resolved:

                Issue deployment