This repository extensively uses git submodules to pull in documentation files from their respective projects.
You can clone this repository with git clone --recursive
, or use git submodule update --init
after cloning the
repository to initialize all submodules.
Submodules are located in repo/$productName/$productVersion
for each product and product version. The submodule should
be locked to a branch that contains the documentation of a certain version (which probably is a release branch).
Since submodules can not be used to check out a part of a repository, we put symlinks that go to the manuals folders in
the submodules in docs/$productName/$productVersion
The docs/$productName/_hugo
folder contains a configuration file that is used to override the default configuration
of xenit-markdowntowebsite.
- Run
build-websites.sh
- Websites are available in
build/website
, and an archive inbuild/website.tar.gz
git submodule add -b <release-branch> git@bitbucket.org:xenit/<repository>.git repo/<productName>/<versionNumber>
ln -s ../../repo/<productName>/<versionNumber>/<path-to-docs-directory> docs/<productName>/<versionNumber>
- Edit
build-websites.sh
to add abuild_and_split_manual
step for the new version:build_and_split_manual <productName> <versionNumber> <filesForPandoc>
- Go to the submodule you want to update
cd repo/<productName>/<versionNumber>
- Checkout the commit you want to update to
git fetch && git checkout <commit/tag/branch>
- Go back to the main repository
cd ../../..
- Add the changes to the submodule
git add repo/<productName>/<versionNumber>
- Commit with a message like
Update manuals for <productName> <versionNumber>
Follow deployment instructions in the Wiki page A2Hosting for www.xenit.eu section docs.xenit.eu.