feat(admin): bootstrap the Administrator-Guide and write the Release-Process

Closes #45
Julien Dessaux 2025-04-21 22:28:56 +02:00
parent 6e807ef6ee
commit 53cb6c5d7a
Signed by: adyxax
GPG key ID: F92E51B86E07177E
2 changed files with 42 additions and 0 deletions

13
Administrator-Guide.md Normal file

@ -0,0 +1,13 @@
# Administrator Guide
These documents are targeted to people who run TfStated on their infrastructure.
A reasonable level of proficiency in using one's operating system of choice is
expected. Networking and Database administration basics are strongly
recommended.
- [[Release Process]]
- [[Installation]]
- [[Configuration]]
- [[Upgrading]]
- [[Troubleshooting]]
- [[Reverse Proxy]]

29
Release-Process.md Normal file

@ -0,0 +1,29 @@
# Release process
TfStated follows [semver](https://semver.org/) versioning.
## Patch releases
Patch releases are published frequently and provide fixes for bugs and security
vulnerabilities in TfStated or its dependencies. Only the latest published
feature released should be expected to be maintained.
Fixes for older feature releases might happen if someone [hires
me](mailto:julien.dessaux@adyxax.org) to maintain them.
## Feature releases
Feature releases are less frequent and do not follow a strict schedule.
Administrators interested in new features should follow [the project's
milestones](https://git.adyxax.org/adyxax/tfstated/milestones) to get an idea of
when the next feature release might come. Everyone is welcome to voice their
interest in features by commenting on their respective issues.
Administrators should [backup](./Backup) and thoroughly read the [release
notes](https://git.adyxax.org/adyxax/tfstated/releases) for each version before
[upgrading](./Upgrading). Only upgrades from one feature release to the next in
one of the deployment options listed in this guide will be tested.
Skipping feature releases might or might not work: use your best judgement based
on the contents of the release notes. Another option is to [hire
me](mailto:julien.dessaux@adyxax.org) to help perform your upgrades.