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

Speed up site generation

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.10.0, 1.9.6
    • Component/s: doc
    • Labels:
      None

      Description

      Generating the documentation site is rather slow because oak-doc currently uses a parser that is not maintained anymore. See: https://github.com/sirthias/pegdown/

      The deprecation note also mentions performance issues. My experience shows, the parser has difficulties with underscores in words. E.g. DOCUMENT_NS_BGW_NUM_WRITE_RATE is a name for a metric I wanted to document. Parsing time seems to increase exponentially the more such names appear in a markdown file.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                mreutegg Marcel Reutegger
                Reporter:
                mreutegg Marcel Reutegger
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: