[
https://issues.apache.org/jira/browse/GEODE-2507?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15883577#comment-15883577
]
ASF GitHub Bot commented on GEODE-2507:
---------------------------------------
Github user metatype commented on a diff in the pull request:
https://github.com/apache/geode-site/pull/1#discussion_r103039403
--- 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 --
Thanks!
> Acquire and populate new geode-site repo for the web site
> ---------------------------------------------------------
>
> Key: GEODE-2507
> URL: https://issues.apache.org/jira/browse/GEODE-2507
> Project: Geode
> Issue Type: New Feature
> Components: web-content
> Reporter: Karen Smoler Miller
> Assignee: Karen Smoler Miller
>
> Move the web site content to its own repo.
> 1. Acquire the repo. Name it geode-site.
> 2. Populate the repo with the current web site's contents on the master branch
> 3. Request that the asf-site branch be switched from the geode repo to this
> new geode-site repo, and test that everything works
> 4. Update the contents of LICENSE files for geode and geode-site
> 5. Setup auto-publish by creating an INFRA JIRA ticket
> 6. Revise README for publishing instructions
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
