[ https://issues.apache.org/jira/browse/CASSANDRA-16763?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Anthony Grasso updated CASSANDRA-16763: --------------------------------------- Authors: Anthony Grasso, Lorina Poland (was: Anthony Grasso) Test and Documentation Plan: The Cassandra documentation can be rendered using the tooling in the cassandra-website repository. The steps to do this are as follows. *Step 1. Set up the cassandra-website tooling* Clone the cassandra-website to your local machine by running the following command. {code:java} $ git clone https://github.com/apache/cassandra-website.git{code} Build the ui-bundle.zip to style the documentation by running the following command. {code:java} $ ./run.sh website-ui bundle {code} The ui-bundle.zip file will be located in site-ui/build/ *Step 2. Render the documentation* Render the website and documentation HTML for the latest three branches of Cassandra using the following command. {code:java} $ ./run.sh website build \ -i -z site-ui/build/ui-bundle.zip \ -u cassandra:https://github.com/polandll/cassandra.git{code} The rendered HTML will be located in site-content/build/html/ To view the documentation open a browser and navigate to {{{}file:///<path_to_cassandra_website>/site-content/build/html/Cassandra{}}}/ Status: Patch Available (was: In Progress) Three patches are now available. ||Branch||Patch|| |trunk|[#1128|https://github.com/apache/cassandra/pull/1128]| |cassandra-4.0|[#1355|https://github.com/apache/cassandra/pull/1355]| |cassandra-3.11|[#1129|https://github.com/apache/cassandra/pull/1129]| The reason we need multiple patches is because the Antora YAML file on each branch needs to specify a different version and version_name. Otherwise, the documentation will fail to render. > Create Cassandra documentation content for new website > ------------------------------------------------------ > > Key: CASSANDRA-16763 > URL: https://issues.apache.org/jira/browse/CASSANDRA-16763 > Project: Cassandra > Issue Type: Task > Components: Documentation/Website > Reporter: Anthony Grasso > Assignee: Anthony Grasso > Priority: High > > We need create the content (asciidoc) to render the Cassandra documentation > using Antora. This work can commence once the following has happened: > * Website and documentation proof of concept is done - CASSANDRA-16029 > * Website design and concept is done - CASSANDRA-16115 > * Website and document tooling is done - CASSANDRA-16066 > * Website UI components are done - CASSANDRA-16762 -- This message was sent by Atlassian Jira (v8.20.1#820001) --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org