Add verified-state to document status field

esrlabs · Oct 14, 2024 · 08d6e3f · 08d6e3f
1 parent 19c6c0a
commit 08d6e3f
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 6 deletions.
diff --git a/dox_style/documentation/source/pages/user/config/document_status.rst b/dox_style/documentation/source/pages/user/config/document_status.rst
@@ -7,7 +7,7 @@ Lifecycle Model
 ---------------
 
 Documents like guidelines or project documentations have a lifecycle.
-This extension provides three different states for a Sphinx document:
+This extension provides four different states for a Sphinx document:
 
 .. list-table::
     :widths: 8 92
@@ -22,10 +22,15 @@ This extension provides three different states for a Sphinx document:
             Draft
       - The document was reviewed and is already in a good shape.
         Some parts may still be missing but the existing information is reliable.
+    * - .. rst-class:: header-label document-status-verified
+
+            Verified
+      - The document is complete and trustworthy. No review findings are open.
+        It was also checked regarding formal aspects.
     * - .. rst-class:: header-label document-status-released
 
             Released
-      - The document is complete and trustworthy. No review findings are open.
+      - The document is approved and valid.
 
 Usually a document lifecycle also consists of a status like *Under Review*, but if pull requests
 are reviewed within a review tool before being merged, this status is not explicitly needed for
@@ -34,6 +39,8 @@ published Sphinx files.
 The status can be changed at any time. But every status change should be reviewed within a review
 tool before being merged. This also applies when deleting the document.
 
+A typical lifecycle looks like this:
+
 .. image:: document_status/document_lifecycle.drawio.png
     :scale: 100%
     :align: center

diff --git a/...entation/source/pages/user/config/document_status/document_lifecycle.drawio.png b/...entation/source/pages/user/config/document_status/document_lifecycle.drawio.png
diff --git a/dox_style/dox_style/config/_static/breadcrumbs.html b/dox_style/dox_style/config/_static/breadcrumbs.html
@@ -35,7 +35,7 @@
             {% set document_status_value = document_status_key.title() %}
             {% set document_status_key = document_status_key.replace(' ', '') %}
 
-            {% if document_status_key not in ['created', 'draft', 'released'] %}
+            {% if document_status_key not in ['created', 'draft', 'verified', 'released'] %}
                 {% set document_status_key = 'created' %}
                 {% set document_status_value = 'Invalid document status: ' + document_status_value %}
             {% endif %}

diff --git a/dox_style/dox_style/config/_static/colors.css b/dox_style/dox_style/config/_static/colors.css
@@ -2,9 +2,9 @@
 
  Note:
  - red    same as restricted / created
- - green  same as unrestricted / released
- - blue   same as confidential
  - orange same as highlyconfidential / draft
+ - blue   same as confidential / verified
+ - green  same as unrestricted / released
 */
 
 .green       {            color:rgb( 33, 215,  38); }

diff --git a/dox_style/dox_style/config/_static/header.css b/dox_style/dox_style/config/_static/header.css
@@ -23,4 +23,5 @@
 
 .document-status-created                { color:rgb(253,  13,  27); }
 .document-status-draft                  { color:rgb(253, 149,  38); }
+.document-status-verified               { color:rgb( 40,  36, 251); }
 .document-status-released               { color:rgb( 33, 215,  38); }
diff --git a/dox_style/dox_style/version.py b/dox_style/dox_style/version.py
@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "0.2.1"