kilroy web ui 📉
This README provides info about the development process.
For more info about kilroyweb itself see
package README or
docs.
Using docker:
docker build -t kilroyweb . && docker run --rm -it kilroyweb --helpEverything strongly related to kilroyweb itself (e.g. source code)
should be placed in the kilroyweb directory.
Everything related to the development of kilroyweb (e.g. Dockerfile)
should be placed at the top level.
In particular the source code and documentation of kilroyweb
should be placed in kilroyweb/src and kilroyweb/docs respectively.
When you push changes to remote, different GitHub Actions run to ensure project consistency. There are defined workflows for:
- deploying docs to GitHub Pages
- testing Docker builds
- drafting release notes
- uploading Docker images to GitHub registry
For more info see the files in .github/workflows directory
and Actions tab on GitHub.
Generally if you see a red mark next to your commit on GitHub
or a failing status on badges in README it means the commit broke something
(or workflows themselves are broken).
Every time you merge a pull request into main,
a draft release is automatically updated, adding the pull request to changelog.
Changes can be categorized by using labels.
You can configure that in .github/release-drafter.yml file.
Every time you publish a release, the Docker image is uploaded to GitHub registry with version taken from release tag.
We are using mkdocs
with material
for building the docs.
It lets you write the docs in Markdown format
and creates a nice webpage for them.
Docs should be placed in kilroyweb/docs/docs.
They are pretty straightforward to write.
If you want to build the docs manually
(for example to see how they look without publishing them)
you should first install the requirements listed
in kilroyweb/docs/requirements.txt into your python environment.
Then cd into kilroyweb/docs and run:
mkdocs buildIt will generate site directory with the webpage source.