How to use this

Using this wiki doesn’t require any programming – just some git and Github manipulation.

Initial set-up

1. Fork this repo

Click the Fork button on the Github repo..

2. Update the submodule to point at your new wiki

Clone the repository locally:

git clone https://github.com/<you>/<your-new-repo> && cd $_

Remove the submodule link to this wiki:

git submodule deinit --all
rm -rf .git/modules/*
git rm -rf .gitmodules wiki

Add the submodule link to your wiki:

git submodule add https://github.com/<you>/<your-new-repo>.wiki wiki

3. Update the tech docs config

Edit the config/tech-docs.yml file and fill out information from your own service. See the tech-docs-template documentation for how to do this.

Commit and push the changes:

git commit -a
git push origin master

4. Enable Github Pages (or use another deployment step)

Github Actions will automatically build and push your wiki to the gh-pages branch of your repository.

Go to your repository settings and enable Github Pages, and specify the gh-pages branch as the target. After a few minutes, your new site will be available.

Editing the content

When you save an edit to your Github Wiki, the changes will be synced automatically to Github Pages. This can take a few minutes.