karel/salt-gitea-formula
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve state docs

Browse Source
This commit is contained in:
jeanluc
2023-02-05 20:00:22 +01:00
parent c58b3ea081
commit 4a83af2a30
14 changed files with 87 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/states.rst
View File

@@ -11,36 +11,44 @@ gitea
^^^^^
*Meta-state*.
This installs the gitea package,
manages the gitea configuration file
and then starts the associated gitea service.
This installs Gitea,
manages its configuration
and then starts the ``gitea`` service.
gitea.package
^^^^^^^^^^^^^
This state will install the gitea package only.
Installs Gitea only.
Releases are downloaded from the official server by default
and their signatures verified.
gitea.config
^^^^^^^^^^^^
This state will configure the gitea service
and has a dependency on ``gitea.install`` via include list.
Manages Gitea configuration.
Has a dependency on `gitea.package`_.
gitea.service
^^^^^^^^^^^^^
This state will start the gitea service
and has a dependency on ``gitea.config`` via include list.
Starts the Gitea service and enables it at boot time.
Has a dependency on `gitea.config`_.
gitea.go
^^^^^^^^
Creates a build user and downloads Go.
Required for building Chroma.
gitea.mods.rst
^^^^^^^^^^^^^^
Compiles `Chroma <https://github.com/alecthomas/chroma>`_ from source
and installs a Python script that can be setup as an external renderer
for ``*.rst`` files.
Has a dependency on `gitea.go`_.
gitea.clean
@@ -58,28 +66,28 @@ Some paths are left to avoid accidental data loss
gitea.package.clean
^^^^^^^^^^^^^^^^^^^
This state will remove the gitea package and has a depency on
``gitea.config.clean`` via include list.
Removes Gitea.
Has a dependency on `gitea.config.clean`_.
gitea.config.clean
^^^^^^^^^^^^^^^^^^
This state will remove the configuration of the gitea service and has a
dependency on ``gitea.service.clean`` via include list.
Removes Gitea configuration. Has a dependency on `gitea.service.clean`_.
gitea.service.clean
^^^^^^^^^^^^^^^^^^^
This state will stop the gitea service and disable it at boot time.
Stops the gitea service and disables it at boot time.
gitea.go.clean
^^^^^^^^^^^^^^
Removes the build user and Go installation.
gitea.mods.rst.clean
^^^^^^^^^^^^^^^^^^^^
Removes the built ``chroma`` binary, the build path and the
``grst`` script.