New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reorganize documentation #550

Open

hmpf opened this issue Apr 10, 2024 · 0 comments

Contributor

hmpf commented Apr 10, 2024

Slim the README by moving most of it to a new documentation-tree.

Not a suggested TOC, names are hard:

production
- 12 factor config
  - docker example
  - bare metal example (systemd?)
development
- set up
  - overriding default config with envvars
- rules for commit messages
- rules for branch names
- rules for how to tag
- rules for changelog/notes
- release procedure
reference with all configuration options
troubleshooting (e.g. oauth2)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment