This documentation site is a Jekyll based site for the ManageIQ documentation.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)Create a test directory and proceed into it:
mkdir test && cd test
Clone manageiq.org
repository:
git clone https://github.com/ManageIQ/manageiq.org manageiq.org
Clone manageiq-documentation
repository:
git clone https://github.com/ManageIQ/manageiq-documentation manageiq-documentation
Create local copies of all remote branches in manageiq-documentation
then checkout master
branch:
(cd manageiq-documentation && git branch -r --format='%(refname:short)' | sed 's/.*\///;/HEAD/d' | xargs -L 1 -I '{}' git checkout '{}' && git checkout master)
Set the location of the manageiq-documentation
repository:
export MIQ_REF_REPO="$(readlink -f manageiq-documentation)"
Proceed into the manageiq-documentation
repository:
cd manageiq-documentation
Submit your changes in the manageiq-documentation
repository on master
branch:
master
branch using git checkout ...
(be sure not to discard any important data while doing so).git add ...
/ git rm ...
master
branch using git commit ...
Remove residual build files from the previous builds (if present):
rm -r /tmp/manageiq-documentation
Build the documentation website and deploy to the local server (might take a minute):
(cd ../manageiq.org && exe/miq build reference && exe/miq serve)
Open this link in your browser to access the local documentation website contaning your changes.
Note: (optional) the static documentation website you've built at this point is located under the ../manageiq.org/dest
directory.
You can deploy it to an HTTP-server of your choice on current or any other workstation.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See LICENSE.txt.