Add a legend for tags with links to the policy

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

.gitlab-ci.yml

@@ -9,6 +9,7 @@ default:
 
 variables:
   OSNAME: apertis
+  OS_WEBSITE: www.apertis.org
   GITLAB_RULES_GIT: $CI_SERVER_URL/infrastructure/$OSNAME-infrastructure.git
   GITLAB_RULES_FILE: gitlab-scripts/rulez.yaml
   DEBUG:
@@ -562,6 +563,7 @@ packaging-updates-upstream-linux:
         --current-job-url "$CI_JOB_URL"
         --current-pipeline-url "$CI_PIPELINE_URL"
         --new-pipeline-url "$CI_PROJECT_URL/-/pipelines/new?ref=$CI_COMMIT_REF_NAME"
+        --os-website-url "${OS_WEBSITE}"
     - ./bin/tsv
         --data packaging.json
         --destdir tsv/

bin/dashboard

@@ -134,7 +134,7 @@ def render(packaging_data, storage_data, destdir):
 
         logging.debug(f"Generating {destdir}/{html}.html")
         rendered = env.get_template(f"{html}.html.jinja2").render(
-            **data, both_data=both_data
+            **data, both_data=both_data, website_url=args.os_website_url
         )
         with open(destdir / f"{html}.html", "w") as html_file:
             html_file.write(rendered)
@@ -190,6 +190,11 @@ if __name__ == "__main__":
         type=argparse.FileType("r"),
         help="storage stats input file in YAML format",
     )
+    parser.add_argument(
+        "--os-website-url",
+        default="www.apertis.org",
+        help="URL to the OS website",
+    )
     parser.add_argument("--destdir", required=True, type=str, help="output directory")
     args = parser.parse_args()
 

templates/base.html.jinja2

@@ -58,6 +58,10 @@
       </div>
 
       {% block content %} {% endblock %}
+
+      <div class="d-flex align-items-baseline justify-content-between">
+        {% block legend %}{% endblock %}
+      </div>
     </main>
   </body>
 </html>

templates/index.html.jinja2

@@ -456,3 +456,23 @@
   {% endfor %}
   </div>
 {% endblock %}
+
+{% block legend %}
+  <div class="list-group">
+            <p>
+            <strong>🛈 Legend: </strong>
+            <ul>
+            <li><big><span class="badge badge-danger">error</span></big>: This tag reports an error that needs to be fixed!</li>
+            <li><big><span class="badge badge-warning">warning</span></big>: This tag reports an issue that needs to be investigated!</li>
+            <li><big><span class="badge badge-info">info</span></big>: This tag reports only information.</li>
+            <li><big><span class="badge border">licensing</span></big>: This tag is about a potential issue with the package license, see <a href="https://{{ website_url }}/policies/license-expectations/">License Expectations</a>.</li>
+            <li><big><span class="badge border">delta</span></big>: This tag is about the changes in packages against upstream, see <a href="https://{{ website_url }}/policies/upstreaming/">Upstreaming</a>.</li>
+            <li><big><span class="badge border">update</span></big>: This tag is about available package updates, see <a href="https://{{ website_url }}/policies/release-flow/">Release flow</a>.</li>
+            <li><big><span class="badge border">git</span></big>: This tag is about a potential issue with source packages in Git repositories, see <a href="https://{{ website_url }}/policies/package_maintenance/">Package maintenance</a>.</li>
+            <li><big><span class="badge border">apt</span></big>: This tag is about a potential issue with binary packages in Apt repositories, see <a href="https://{{ website_url }}/policies/package_maintenance/">Package maintenance</a>.</li>
+            <li><big><span class="badge border">obs</span></big>: This tag is about a potential issue with packages in OBS repositories, see <a href="https://{{ website_url }}/policies/package_maintenance/">Package maintenance</a>.</li>
+            </ul>
+            </p>
+            <p>For more information, please refer to the Apertis policy at <a href="https://{{ website_url }}/">{{ website_url }}</a>.</p>
+    </div>
+{% endblock %}