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

docs: formatting (Update from template)

Browse Source
This commit is contained in:
jeanluc
2023-02-05 23:16:54 +01:00
parent 0e7254a8c2
commit 5af9a75618
6 changed files with 58 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/README.rst
View File

@@ -84,8 +84,8 @@ The following states are found in this formula:
:local:
gitea
^^^^^
``gitea``
^^^^^^^^^
*Meta-state*.
This installs Gitea,
@@ -93,34 +93,34 @@ manages its configuration
and then starts the ``gitea`` service.
gitea.package
^^^^^^^^^^^^^
``gitea.package``
^^^^^^^^^^^^^^^^^
Installs Gitea only.
Releases are downloaded from the official server by default
and their signatures verified.
gitea.config
^^^^^^^^^^^^
``gitea.config``
^^^^^^^^^^^^^^^^
Manages Gitea configuration.
Has a dependency on `gitea.package`_.
gitea.service
^^^^^^^^^^^^^
``gitea.service``
^^^^^^^^^^^^^^^^^
Starts the Gitea service and enables it at boot time.
Has a dependency on `gitea.config`_.
gitea.go
^^^^^^^^
``gitea.go``
^^^^^^^^^^^^
Creates a build user and downloads Go.
Required for building Chroma.
gitea.mods.rst
^^^^^^^^^^^^^^
``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.
@@ -128,11 +128,11 @@ for ``*.rst`` files.
Has a dependency on `gitea.go`_.
gitea.clean
^^^^^^^^^^^
``gitea.clean``
^^^^^^^^^^^^^^^
*Meta-state*.
This state will undo everything performed in the ``gitea`` meta-state
Undoes everything performed in the ``gitea`` meta-state
in reverse order, i.e.
stops the service,
removes the configuration file and then
@@ -141,29 +141,29 @@ Some paths are left to avoid accidental data loss
(namely ``GITEA_WORKDIR``, ``APP_DATA_PATH`` and the gitea user home).
gitea.package.clean
^^^^^^^^^^^^^^^^^^^
``gitea.package.clean``
^^^^^^^^^^^^^^^^^^^^^^^
Removes Gitea.
Has a dependency on `gitea.config.clean`_.
gitea.config.clean
^^^^^^^^^^^^^^^^^^
``gitea.config.clean``
^^^^^^^^^^^^^^^^^^^^^^
Removes Gitea configuration. Has a dependency on `gitea.service.clean`_.
gitea.service.clean
^^^^^^^^^^^^^^^^^^^
``gitea.service.clean``
^^^^^^^^^^^^^^^^^^^^^^^
Stops the gitea service and disables it at boot time.
gitea.go.clean
^^^^^^^^^^^^^^
``gitea.go.clean``
^^^^^^^^^^^^^^^^^^
Removes the build user and Go installation.
gitea.mods.rst.clean
^^^^^^^^^^^^^^^^^^^^
``gitea.mods.rst.clean``
^^^^^^^^^^^^^^^^^^^^^^^^
Removes the built ``chroma`` binary, the build path and the
``grst`` script.

50
docs/states.rst
View File

@@ -7,8 +7,8 @@ The following states are found in this formula:
:local:
gitea
^^^^^
``gitea``
^^^^^^^^^
*Meta-state*.
This installs Gitea,
@@ -16,34 +16,34 @@ manages its configuration
and then starts the ``gitea`` service.
gitea.package
^^^^^^^^^^^^^
``gitea.package``
^^^^^^^^^^^^^^^^^
Installs Gitea only.
Releases are downloaded from the official server by default
and their signatures verified.
gitea.config
^^^^^^^^^^^^
``gitea.config``
^^^^^^^^^^^^^^^^
Manages Gitea configuration.
Has a dependency on `gitea.package`_.
gitea.service
^^^^^^^^^^^^^
``gitea.service``
^^^^^^^^^^^^^^^^^
Starts the Gitea service and enables it at boot time.
Has a dependency on `gitea.config`_.
gitea.go
^^^^^^^^
``gitea.go``
^^^^^^^^^^^^
Creates a build user and downloads Go.
Required for building Chroma.
gitea.mods.rst
^^^^^^^^^^^^^^
``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.
@@ -51,11 +51,11 @@ for ``*.rst`` files.
Has a dependency on `gitea.go`_.
gitea.clean
^^^^^^^^^^^
``gitea.clean``
^^^^^^^^^^^^^^^
*Meta-state*.
This state will undo everything performed in the ``gitea`` meta-state
Undoes everything performed in the ``gitea`` meta-state
in reverse order, i.e.
stops the service,
removes the configuration file and then
@@ -64,29 +64,29 @@ Some paths are left to avoid accidental data loss
(namely ``GITEA_WORKDIR``, ``APP_DATA_PATH`` and the gitea user home).
gitea.package.clean
^^^^^^^^^^^^^^^^^^^
``gitea.package.clean``
^^^^^^^^^^^^^^^^^^^^^^^
Removes Gitea.
Has a dependency on `gitea.config.clean`_.
gitea.config.clean
^^^^^^^^^^^^^^^^^^
``gitea.config.clean``
^^^^^^^^^^^^^^^^^^^^^^
Removes Gitea configuration. Has a dependency on `gitea.service.clean`_.
gitea.service.clean
^^^^^^^^^^^^^^^^^^^
``gitea.service.clean``
^^^^^^^^^^^^^^^^^^^^^^^
Stops the gitea service and disables it at boot time.
gitea.go.clean
^^^^^^^^^^^^^^
``gitea.go.clean``
^^^^^^^^^^^^^^^^^^
Removes the build user and Go installation.
gitea.mods.rst.clean
^^^^^^^^^^^^^^^^^^^^
``gitea.mods.rst.clean``
^^^^^^^^^^^^^^^^^^^^^^^^
Removes the built ``chroma`` binary, the build path and the
``grst`` script.