Github user scmbuildguy commented on a diff in the pull request:
https://github.com/apache/geode-site/pull/1#discussion_r103036407
--- Diff: README.md ---
@@ -20,3 +20,58 @@ limitations under the License.
[](https://travis-ci.org/apache/geode-site)
[](https://www.apache.org/licenses/LICENSE-2.0)
# Apache Geode Site
+
+This directory contains the source files for the project
[website](https://geode.apache.org). Website content is written in
[Markdown](https://help.github.com/articles/markdown-basics) and the site files
are generated from that source by a tool called
[Pandoc](http://johnmacfarlane.net/pandoc).
+
+Source files for the website are in `website/content`. Generated files for
the website are in `build/content`.
+
+**NOTE:** To make changes to the [Apache Geode User
Guide](http://geode.apache.org/docs/), which is published to the website:
+
+- Review
[CONTRIBUTING](https://github.com/apache/geode/blob/develop/geode-docs/CONTRIBUTE.md)
for information about contributing to the documentation source files.
+- Follow the
[README](https://github.com/apache/geode/blob/develop/geode-book/README.md) for
information about building a local version of the guide and adding it to the
website.
+
+The website is updated by a "sync" tool that monitors the __asf-site__
branch
+of our Git repo, so after making changes you must place your updated source
+and generated files on the __asf-site__ branch and push.
+The content will be published to the
+[Geode website](http://geode.apache.org) after a 5-20 minute delay.
+
+## Prerequisites
+
+To generate the site locally, you need to install java and docker.
+
+## How to change/update the website
+
+### 1. Find and edit the source files you need to change
+
+Source files for the website are in ``website/content``. When changing
the content of the site, find the Markdown files that you
+need to edit and make your change. If you need to change the layout or
styling of the site, then you will probably need to change
+an HTML, JS or CSS file.
+
+### 2. Locally generate the site and test your changes
+
+To generate the site content, run the `nanoc` compiler:
+
+ $ ./gradlew compile
+
+To view the generated site, run:
+
+ $ ./gradlew view
+
+and point your browser at `http://localhost:3000`. To make further
changes, stop the build, edit files, recompile, and view again.
+
+### 3. Publish your changes to the site
+
+Once you are happy with your changes, commit them to the __master__ branch.
+The changes also need to be propagated to the __asf-site__ branch. Run the
+gradle command
+
+ $ ./gradlew publish
+
+to checkout the __asf-site__ branch and copy the website files. You will
+need to manually commit and push your changes on the __asf-site__ branch.
+
+The site should update in 5-10 minutes. If it does not,
--- End diff --
Earlier in the document it states update will have in 5-20 minutes, looking
for consistency
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
