| commit | 0257544b96c88edbf84df222a487cb483e805244 | [log] [tgz] |
|---|---|---|
| author | Dave Barnes <dbarnes@pivotal.io> | Fri Apr 06 13:06:48 2018 -0700 |
| committer | Dave Barnes <dbarnes@pivotal.io> | Fri Apr 06 13:06:48 2018 -0700 |
| tree | 511d76534f4687b85930d06be87c6bf24b62da28 | |
| parent | 52b797b762c0aaab07c44840b3761f6fb921ebff [diff] |
Add 1.5 user guide to site
This directory contains the source files for the project website. Website content is written in Markdown and the site files are generated from that source by a tool called 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, which is published to the website:
geode-book directory 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 after a 5-10 minute delay.
To generate the site locally, you need to install java and docker.
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.
To generate the site content, navigate to the top level directory of the repo and use gradle to 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.
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,