Here we explain how to edit this documentation locally and submit changes for online publication.
Our web site repository contains two branches.
Master branch contains markdown content of the site, gh-pages branch contains static html of the site.
Hugo static site generator is used to produce html content from markdown pages.
GitHub is configured to host content of gh-pages branch at this address.
Users are modifying site content by providing pull requests to master branch. Travis continuous integration automatically generates
fresh html of the site and updates gh-pages branch.
To modify documentation follow these steps:
$HOME/bin directory, for example.Make a fork of our site repository and clone your fork locally:
Please note, that repository contains submodule (external Hugo theme), so clone command should be
git clone https://jugit.fz-juelich.de/mlz/doc/bornagain-www.git
Besides the usual git pull, we also need to update the submodule:
git pull
git pull --recurse-submodules
git submodule update --remote --recursive
Go to cloned repository and run Hugo.
$ cd <source>
$ hugo server -D
Open web-browser using address Hugo will tell you (most probably http://localhost:1313/).
The documentation sources are in directory content/.
They consist of Markdown files.
For example, the source of the page you are looking at right now, is
content/m/developers-corner/contribute-to-documentation.md
Edit any source file. Hugo will then update the web site within a fraction of a second.
When you are happy with the changes you’ve made, commit them, push them to origin,
and create a pull request.
Travis will start the build to make sure that site is still in working state (no broken links found, etc).
Depending on Travis mood and load, the build can be completed in less than a minute.
Project members are authorized to merge their own pull requests. External users will have to wait for some of us to approve.
After pull request merge, check site online. It might take a few minutes before changes will be propagated to hosting service.
reload button while holding shift key).
See also bypass your cache.