Github user metatype commented on a diff in the pull request:
https://github.com/apache/geode-site/pull/1#discussion_r103040225
--- 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
--- End diff --
You might be able to run under cygwin.
---
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.
---
