This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/geode-site.git
The following commit(s) were added to refs/heads/master by this push:
new 6fcc65c Added a tip the README file regarding the need for pandoc &
nanoc
6fcc65c is described below
commit 6fcc65c4ac0dfef33236236b8baa2907f94bcc7b
Author: Dave Barnes <[email protected]>
AuthorDate: Wed Apr 24 16:58:54 2019 -0700
Added a tip the README file regarding the need for pandoc & nanoc
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index 1503214..f64837b 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,11 @@ When the site's updated framework has been fleshed-out with
external content, th
To generate the site locally, you need to install java and docker.
+Other support tools you may need include:
+
+- pandoc
+- nanoc
+
## Update the website framework
On the __master__ branch, update the website's framework pages. For a general
release, this would likely include:
@@ -71,6 +76,9 @@ You should still be on the __master__ branch.
```
$ ./gradlew compile
```
+
+ You may need to suppress rat checking: add `-x rat` to the end of the
`.gradlew` command.
+
2. View the generated site by running:
```
@@ -79,6 +87,8 @@ You should still be on the __master__ branch.
and point your browser at `http://localhost:3000` to view the result.
+ You may need to suppress rat checking: add `-x rat` to the end of the
`.gradlew` command.
+
3. To make further changes, stop the build (Ctrl-C), edit files, recompile,
and view again.
4. Once you are happy with your changes, commit them to the __master__ branch
and push them to the upstream Apache repository.
