[CASSANDRA-17517] In-tree documentation takes a long time to generate

• Type: Improvement
• Status: In Progress
• Priority: High
• Resolution: Unresolved
• Component/s: Documentation/Website
• Change Category: Performance
• Complexity: Challenging
• Platform: All
• Assignee: Anthony Grasso
• Reporter: Anthony Grasso

Authors

Anthony Grasso

• Created: 03/Apr/22 15:33
• Updated: 13/Jan/23 09:35

Description

To generate the in-tree documentation the website-content tooling will execute the following steps for each branch.

1. Copy or clone the Cassandra repository depending on the URL supplied
2. Checkout the branch
3. Select the version of Java based on the Cassandra version
4. Compile Cassandra
5. Generate ADOC files for Nodetool and the Cassandra YAML configuration
6. Commit to repository

Once the generated ADOC files are committed to the repository, Antora is executed to generate the HTML.

The majority of the time taken to execute the above steps is in Step 4 where Cassandra is compiled. This time could be reduced by downloading the precompiled binaries for branches and tags.