docs: improve state docs

2023-02-05 20:00:22 +01:00
parent c58b3ea081
commit 4a83af2a30
14 changed files with 87 additions and 46 deletions
--- a/gitea/package/clean.sls
+++ b/gitea/package/clean.sls
@@ -1,8 +1,8 @@
 # vim: ft=sls

 {#-
-    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`_.
 #}

 {%- set tplroot = tpldir.split('/')[0] %}
--- a/gitea/package/init.sls
+++ b/gitea/package/init.sls
@@ -1,7 +1,10 @@
 # vim: ft=sls

 {#-
-    This state will install the gitea package only.
+    Installs Gitea only.
+
+    Releases are downloaded from the official server by default
+    and their signatures verified.
 #}

 include: