http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/a48871ed/geode-book/redirects.rb ---------------------------------------------------------------------- diff --git a/geode-book/redirects.rb b/geode-book/redirects.rb index e913407..71f50d9 100644 --- a/geode-book/redirects.rb +++ b/geode-book/redirects.rb @@ -14,5 +14,5 @@ #permissions and limitations under the License. r301 %r{/releases/latest/javadoc/(.*)}, 'http://geode.incubator.apache.org/releases/latest/javadoc/$1' -rewrite '/', '/docs/about_geode.html' -rewrite '/index.html', '/docs/about_geode.html' +rewrite '/', '/docs/guide/about_geode.html' +rewrite '/index.html', '/docs/guide/about_geode.html'
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/a48871ed/geode-docs/about_geode.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/about_geode.html.md.erb b/geode-docs/about_geode.html.md.erb index b4f090f..ca6f022 100644 --- a/geode-docs/about_geode.html.md.erb +++ b/geode-docs/about_geode.html.md.erb @@ -19,8 +19,6 @@ See the License for the specific language governing permissions and limitations under the License. --> -This documentation describes product concepts and provides complete setup instructions for Apache Geode 1.0.0-incubating. Source files and instructions on how to build this documentation are available at [https://github.com/project-geode/docs](https://github.com/project-geode/docs) and [https://github.com/project-geode/docs/blob/master/README.md](https://github.com/project-geode/docs/blob/master/README.md). +This documentation describes product concepts and provides complete setup instructions for Apache Geode 1.0.0-incubating. Source files are available at [https://github.com/apache/incubator-geode/tree/develop/geode-docs](https://github.com/apache/incubator-geode/tree/develop/geode-docs) and instructions on how to build this documentation is available at [https://github.com/apache/incubator-geode/blob/develop/geode-book/README.md](https://github.com/apache/incubator-geode/blob/develop/geode-book/README.md). You can also find additional documentation about Geode on the **Apache Geode Wiki**: [https://cwiki.apache.org/confluence/display/GEODE/Index](https://cwiki.apache.org/confluence/display/GEODE/Index). - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/a48871ed/geode-site/website/README.md ---------------------------------------------------------------------- diff --git a/geode-site/website/README.md b/geode-site/website/README.md index ff9ee89..8baf904 100644 --- a/geode-site/website/README.md +++ b/geode-site/website/README.md @@ -2,15 +2,20 @@ This directory contains the source files for the project website. 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 ``${geode-project-dir}/geode-site/website/content`` +Source files for the website are in `${geode-project-dir}/geode-site/website/content`. -Generated files for the website are in ``${geode-project-dir}/geode-site/content`` +Generated files for the website are in `${geode-project-dir}/geode-site/content`. + +NOTE: To make changes to the [Apache Geode User Guide](http://geode.incubator.apache.org/docs/guide/About_Geode.html): + +- See `${geode-project-dir}/geode-docs/CONTRIBUTE.md` for information about contributing to the documentation source files. +- See `${geode-project-dir}/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.incubator.apache.org) after a 5-20 minute delay. +Geode website](http://geode.incubator.apache.org) after a 5-20 minute delay. ## Prerequisites @@ -36,13 +41,15 @@ Install Nanoc and other Ruby Gems needed: Source files for the website are in ``${geode-project-dir}/geode-site/website/content``. When changing the actual content of the site, find the Markdown files that you -need to edit under the ``${geode-project-dir}/geode-site/website/content/docs`` +need to edit under the `${geode-project-dir}/geode-site/website/content/` directory 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 within the ``${geode-project-dir}/geode-site/website/content`` directory. +NOTE: The [Apache Geode User Guide](http://geode.incubator.apache.org/docs/guide/About_Geode.html) source files are in `${geode-project-dir}/geode-docs/`. See `${geode-project-dir}/geode-docs/CONTRIBUTE.md` for more information. + ### 2. Locally generate the site and test your changes Run the nanoc compiler to generate the site. @@ -53,10 +60,11 @@ file to place the locally built website into the With a cwd of ``${geode-project-dir}/geode-site/website``: $ nanoc compile - Run ``git status`` and you should see your changes plus any updated files under the ``${geode-project-dir}/content`` directory. +NOTE: Whether or not you have made changes to the Apache Geode User Guide, you must now build the User Guide and move the User Guide files to the Geode website. For instructions, see `${geode-project-dir}/geode-book/README.md`. + To view your changes locally, use the view command to start a local web server. Check the website at [http://0.0.0.0:3000](http://0.0.0.0:3000) $ nanoc view @@ -76,18 +84,16 @@ top level, ``${geode-project-dir}``, of the __asf-site__ branch. Here is one way to accomplish this: 1. On the __develop__ branch - + $ cd geode-site/website $ nanoc compile $ cd ../content $ tar cvf new-website-content.tar . - $ mv new-website-content.tar ~/Desktop/. -The move of the TAR file is not necessary, but helps to clarify this example. + $ mv new-website-content.tar ~/Desktop/ -2. Expand the TAR file at the top level of the __asf-site__ branch +2. Expand the TAR file at the top level of the __asf-site__ branch (cwd should be ${geode-project-dir}: - $ cd .. (cwd should be ${geode-project-dir}) - $ checkout asf-site + $ git checkout asf-site $ tar xvf ~/Desktop/new-website-content.tar 3. Commit and push on the __asf-site__ branch http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/a48871ed/geode-site/website/content/docs/index.html ---------------------------------------------------------------------- diff --git a/geode-site/website/content/docs/index.html b/geode-site/website/content/docs/index.html index f7f4a50..d09dea0 100644 --- a/geode-site/website/content/docs/index.html +++ b/geode-site/website/content/docs/index.html @@ -31,7 +31,7 @@ under the License. --> <div class="container"> <div class="row"> <div class="col-md-4"> - <h3><a href="http://geode.docs.pivotal.io/"; style="color: #1275ff;">Apache Geode (incubating) User Documentation</a></h3> + <h3><a href="guide/about_geode.html" style="color: #1275ff;">Apache Geode (incubating) User Documentation</a></h3> <p>Installation Instructions, User Manual, other product docs</p> </div> <div class="col-md-4"> @@ -45,4 +45,3 @@ under the License. --> </div> </div> </section> -
