[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #88: Added tl;dr to README.md

[GitBox <gi...@apache.org>]

michaelsembwever commented on a change in pull request #88:
URL: https://github.com/apache/cassandra-website/pull/88#discussion_r783808504



##########
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

Review comment:
       ```suggestion
   # open a browser window and navigate to site-content/build/html/_/index.html
   ```




-- 
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: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org