docs(server_config_environment): regenerate README and update metadata

janikvonrotz · janikvonrotz · commit 664db68ea568 · 2025-10-24T10:12:35.000+02:00
- Replace GPL-3 license badge with AGPL-3
- Add maturity status badge (Beta)
- Include GitHub repository link badge
- Restructure README content with table of contents
- Add bug tracker and credits sections
- Update static description HTML accordingly
- Modify config environment key lookup to prioritize 'running_env' over 'environment'
- Generate separate files for DESCRIPTION, CONTRIBUTORS and USAGE readme sections
diff --git a/server_config_environment/README.rst b/server_config_environment/README.rst
@@ -1,27 +1,60 @@
-.. image:: https://img.shields.io/badge/licence-GPL--3-blue.svg
-    :target: http://www.gnu.org/licenses/gpl-3.0-standalone.html
-    :alt: License: GPL-3
-
-
 ==================
 Config Environment
 ==================
 
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:1b0e2a405cd6bb133ee19a198cb252f1efe3d3848420c6b843846e07cfc1c2cf
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-Mint--System%2FMint--System-lightgray.png?logo=github
+    :target: https://github.com/Mint-System/Mint-System/tree/18.0/server_config_environment
+    :alt: Mint-System/Mint-System
+
+|badge1| |badge2| |badge3|
+
 Define environments for server configurations.
 
-For a detailed documentation have a look at https://www.odoo-wiki.org/server-config-environment.html
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/Mint-System/Mint-System/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/Mint-System/Mint-System/issues/new?body=module:%20server_config_environment%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
 
-Configuration
-~~~~~~~~~~~~~
+* Mint System GmbH
 
-* No additional configurations needed
+Contributors
+~~~~~~~~~~~~
 
-Maintainer
-~~~~~~~~~~
+* Janik von Rotz <login@janikvonrotz.ch>
 
-.. image:: https://raw.githubusercontent.com/Mint-System/Wiki/main/attachments/mint-system-logo.png
-  :target: https://www.mint-system.ch
+Maintainers
+~~~~~~~~~~~
 
-This module is maintained by Mint System GmbH.
+This module is part of the `Mint-System/Mint-System <https://github.com/Mint-System/Mint-System/tree/18.0/server_config_environment>`_ project on GitHub.
 
-For support and more information, please visit `our Website <https://www.mint-system.ch>`__.
+You are welcome to contribute.
diff --git a/server_config_environment/models/server_config_environment.py b/server_config_environment/models/server_config_environment.py
@@ -19,7 +19,7 @@ class ServerConfigEnvironment(models.Model):
 
     def _compute_is_active(self):
         for rec in self:
-            config_environment = config.get("environment")
+            config_environment = config.get("running_env", False) or config.get("environment", False)
             if config_environment and (rec.name == config_environment or rec.key == config_environment):
                 rec.is_active = True
             else:
diff --git a/server_config_environment/readme/CONTRIBUTORS.rst b/server_config_environment/readme/CONTRIBUTORS.rst
@@ -0,0 +1 @@
+* Janik von Rotz <login@janikvonrotz.ch>
diff --git a/server_config_environment/readme/DESCRIPTION.rst b/server_config_environment/readme/DESCRIPTION.rst
@@ -0,0 +1 @@
+Define environments for server configurations.
diff --git a/server_config_environment/readme/USAGE.rst b/server_config_environment/readme/USAGE.rst
diff --git a/server_config_environment/static/description/index.html b/server_config_environment/static/description/index.html
@@ -4,7 +4,7 @@
 <meta charset="utf-8" />
 <meta name="generator" content="Docutils 0.22.2: https://docutils.sourceforge.io/" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
-<title>README.rst</title>
+<title>Config Environment</title>
 <style type="text/css">
 
 /* Minimal style sheet for the HTML output of Docutils.                    */
@@ -618,30 +618,57 @@
 
 </style>
 </head>
-<body>
-<main>
-
-
-<a class="reference external image-reference" href="http://www.gnu.org/licenses/gpl-3.0-standalone.html">
-<img alt="License: GPL-3" src="https://img.shields.io/badge/licence-GPL--3-blue.svg" />
-</a>
-<section id="config-environment">
-<h2>Config Environment</h2>
+<body class="with-toc">
+<main id="config-environment">
+<h1 class="title">Config Environment</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: sha256:1b0e2a405cd6bb133ee19a198cb252f1efe3d3848420c6b843846e07cfc1c2cf
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/Mint-System/Mint-System/tree/18.0/server_config_environment"><img alt="Mint-System/Mint-System" src="https://img.shields.io/badge/github-Mint--System%2FMint--System-lightgray.png?logo=github" /></a></p>
 <p>Define environments for server configurations.</p>
-<p>For a detailed documentation have a look at <a class="reference external" href="https://www.odoo-wiki.org/server-config-environment.html">https://www.odoo-wiki.org/server-config-environment.html</a></p>
-<section id="configuration">
-<h3>Configuration</h3>
+<p><strong>Table of contents</strong></p>
+<nav class="contents local" id="contents" role="doc-toc">
+<ul class="simple">
+<li><p><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></p></li>
+<li><p><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a></p>
+<ul>
+<li><p><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></p></li>
+<li><p><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></p></li>
+<li><p><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></p></li>
+</ul>
+</li>
+</ul>
+</nav>
+<section id="bug-tracker">
+<h2><a class="toc-backref" href="#toc-entry-1" role="doc-backlink">Bug Tracker</a></h2>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/Mint-System/Mint-System/issues">GitHub Issues</a>.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+<a class="reference external" href="https://github.com/Mint-System/Mint-System/issues/new?body=module:%20server_config_environment%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</section>
+<section id="credits">
+<h2><a class="toc-backref" href="#toc-entry-2" role="doc-backlink">Credits</a></h2>
+<section id="authors">
+<h3><a class="toc-backref" href="#toc-entry-3" role="doc-backlink">Authors</a></h3>
+<ul class="simple">
+<li><p>Mint System GmbH</p></li>
+</ul>
+</section>
+<section id="contributors">
+<h3><a class="toc-backref" href="#toc-entry-4" role="doc-backlink">Contributors</a></h3>
 <ul class="simple">
-<li><p>No additional configurations needed</p></li>
+<li><p>Janik von Rotz &lt;<a class="reference external" href="mailto:login&#64;janikvonrotz.ch">login&#64;janikvonrotz.ch</a>&gt;</p></li>
 </ul>
 </section>
-<section id="maintainer">
-<h3>Maintainer</h3>
-<a class="reference external image-reference" href="https://www.mint-system.ch">
-<img alt="https://raw.githubusercontent.com/Mint-System/Wiki/main/attachments/mint-system-logo.png" src="https://raw.githubusercontent.com/Mint-System/Wiki/main/attachments/mint-system-logo.png" />
-</a>
-<p>This module is maintained by Mint System GmbH.</p>
-<p>For support and more information, please visit <a class="reference external" href="https://www.mint-system.ch">our Website</a>.</p>
+<section id="maintainers">
+<h3><a class="toc-backref" href="#toc-entry-5" role="doc-backlink">Maintainers</a></h3>
+<p>This module is part of the <a class="reference external" href="https://github.com/Mint-System/Mint-System/tree/18.0/server_config_environment">Mint-System/Mint-System</a> project on GitHub.</p>
+<p>You are welcome to contribute.</p>
 </section>
 </section>
 </main>
diff --git a/url_slug/models/url_slug_mixin.py b/url_slug/models/url_slug_mixin.py
@@ -1,4 +1,5 @@
 import logging
+
 import slugify
 
 from odoo import api, fields, models

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+* Janik von Rotz <login@janikvonrotz.ch>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Define environments for server configurations.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import logging`
	`2`	`+`
`2`	`3`	`import slugify`
`3`	`4`
`4`	`5`	`from odoo import api, fields, models`