Documentation Server

This page contains all documentation regarding the hmcc-global.github.io/hmccaa-web site which hosts this documentation you are reading.

Deploying

To deploy changes, simply create a PR. This site will be automatically redeployed on every push to the main branch which edits the docs/ folder.

Prequisite: Install honkit.

cd docs
npm install

Then, to run the documentation server locally:

# Run inside docs/ folder
bash serve.sh

This is pretty much the equivalent of:

docker run -it --init -dp 4000:4000  -v `pwd`:`pwd` -w `pwd` --name docs --rm $(docker build -t docs -q .) honkit serve

The Honkit docs are a great resource for learning how to write docs with Honkit.

When pushing code into the remote repository, there are two checks before they push the code

If there is a lint issue, need to correct the lint issue and commit the code. Then you can push the code.

If the pre-push process prettify the code, need to commit the code. Then you can push the code.

If the two checks pass, then the code will be push into remote respository.

If you want to avoid this pre-push proces, then add --no-verify to the git push command

Here are examples to how to do it:

    git push --no-verify

git push --force-with-lease --no-verify

[This option is usually used after rebase current branch with main branch]