michaelsembwever commented on a change in pull request #88: URL: https://github.com/apache/cassandra-website/pull/88#discussion_r783810415
########## File path: README.md ########## @@ -1,5 +1,39 @@ # Apache Cassandra website +Tooling to build the Apache Cassandra website and documentation. + +# tl;dr + +``` +$ git clone https://github.com/apache/cassandra-website.git +$ cd ./cassandra-website + +# make sure you have docker installed + +# website content edits must be done in ./site-content/source/modules +# to build the website only using your local edits +$ ./run.sh website build + +# open a browser window and navigate to file:///<full-path-to-parent-directory>/cassandra-website/site-content/build/html/_/index.html + +# Cassandra documentation content edits must be done in the Apache Cassandra project ./cassandra/doc/modules +$ git clone https://github.com/apache/cassandra.git +$ cd ./cassandra/doc/modules Review comment: ```suggestion $ cd ./cassandra/ # in-tree Cassandra doc edits are done in ./doc/modules ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
