You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by GitBox <gi...@apache.org> on 2022/01/13 06:19:21 UTC
[GitHub] [cassandra-website] ossarga opened a new pull request #88: Added tl;dr to README.md
ossarga opened a new pull request #88:
URL: https://github.com/apache/cassandra-website/pull/88
patch by Anthony Grasso for CASSANDRA-16761
--
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
[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #88: Added tl;dr to README.md
Posted by GitBox <gi...@apache.org>.
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: 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
[GitHub] [cassandra-website] michaelsembwever closed pull request #88: Added tl;dr to README.md
Posted by GitBox <gi...@apache.org>.
michaelsembwever closed pull request #88:
URL: https://github.com/apache/cassandra-website/pull/88
--
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
[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #88: Added tl;dr to README.md
Posted by 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
[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #88: Added tl;dr to README.md
Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #88:
URL: https://github.com/apache/cassandra-website/pull/88#discussion_r783811667
##########
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
+
+# to build the website and Cassandra documentation using your local edits
+$ ./run.sh website build -g -u cassandra:/<full-path-to-parent-directory>/cassandra -b cassandra:<branch-with-changes>
+
+# open a browser window and navigate to file:///<full-path-to-parent-directory>/cassandra-website/site-content/build/html/Cassandra/.../index.html
Review comment:
```suggestion
# open a browser window and navigate to site-content/build/html/Cassandra/.../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
[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #88: Added tl;dr to README.md
Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #88:
URL: https://github.com/apache/cassandra-website/pull/88#discussion_r783811272
##########
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
+
+# to build the website and Cassandra documentation using your local edits
+$ ./run.sh website build -g -u cassandra:/<full-path-to-parent-directory>/cassandra -b cassandra:<branch-with-changes>
Review comment:
```suggestion
cd ../cassandra-website
$ ./run.sh website build -g -u cassandra:$(pwd)/../cassandra -b cassandra:<branch-with-your-changes>
```
--
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
[GitHub] [cassandra-website] michaelsembwever commented on pull request #88: Added tl;dr to README.md
Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on pull request #88:
URL: https://github.com/apache/cassandra-website/pull/88#issuecomment-1012018851
merged manually with https://github.com/apache/cassandra-website/commit/8178b6c23c7ea43178a7a140f4daa4deb38bd393
--
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
[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #88: Added tl;dr to README.md
Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #88:
URL: https://github.com/apache/cassandra-website/pull/88#discussion_r783809612
##########
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
Review comment:
```suggestion
# website content edits are done in ./site-content/source/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: 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