Gearpump This guide is for how to update http://gearpump.apache.org website for a Gearpump release. It is NOT for how to release Gearpump itself.
Directory releases/latest
in this repository holds the release documentation for latest release.
As we are preparing for a new release, you need to rename latest
to some explicit version, e.g. 0.5
to indicate this old release documentation is for 0.5
release.
And you may ONLY want to keep several key release documents, you can remove corresponding obselete releases by removing corresponding version directories under releases
directory.
You need to under Gearpump source code root directory execute command Note: If you are using macos Sierra you'll need to follow these instructions: http://railsapps.github.io/installrubyonrails-mac.html
cd docs ./build_doc.sh 2.11 1
It will generate all release documents under site
.
You need to upload the generated site
directory in previous step to THIS repository's releases/
directory and rename site
directory to latest
.
_config.yml
_layouts/global.html
for current linkFile _layouts/global.html
contains the navigation bar for the whole website. As we updated the release documentation, we need to update the navigation bar to reflect this change.
download.md
for download linkFile download.md
contains the download link for Gearpump. This also needs to be updated.
Please update corresponding pages to reflect Gearpump new features.
You need to run
jekyll build
to generate all the HTML pages. These pages are under site
directory.
You can make a local check by
jekyll serve --watch
And use browser to visit http://127.0.0.1:4000 for a dry run.
Please check in all the pages you modified, all the changes you made under releases
directory, and jekyll generated files under site
directory to Git repository.
And then after a careful check, please raise a PR.
When PR is merged, the website is updated corresponding automatically.
NOTE Here we need to also include site
in Git as there is no automatically mechanism for http://gearpump.apache.org to read from .md
files. Gearpump