Fix minor issues in some comments (#167)

- ci: Improve description of the arm64 `Dockerfile`
- Fix typo in `docs/_css/style.css`
- Update release notes

Author: llucax

.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile

@@ -1,8 +1,8 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-# This Dockerfile is used to test the installation of the python package in
-# multiple platforms in the CI. It is not used to build the package itself.
+# This Dockerfile is used to run the tests in arm64, which is not supported by
+# GitHub Actions at the moment.
 
 FROM docker.io/library/ubuntu:20.04
 

RELEASE_NOTES.md

@@ -1,29 +1,28 @@
 # Frequenz Repository Configuration Release Notes
 
-## Summary
-
-<!-- Here goes a general summary of what this release is about -->
-
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
-
 ### Cookiecutter template
 
-<!-- Here upgrade steps for cookiecutter specifically -->
+Instead of regenerating the templates, you can simply:
 
-## New Features
+- Run this command to fix the typo and wrong `cli` package:
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+  ```sh
+  sed -i 's/annothations/annotations/' docs/_css/style.css
+  sed -i 's/frequenz\.repo\.config\.cli\.version\.mkdocs\.sort/frequenz.repo.config.cli.version.mike.sort/' .github/workflows/ci.yaml
+  ```
 
-### Cookiecutter template
+- Replace the comment after the copyright notice in `.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile` with:
 
-- Show a link to the documentation in PyPI.
+  ```Dockerfile
+  # This Dockerfile is used to run the tests in arm64, which is not supported by
+  # GitHub Actions at the moment.
+  ```
 
 ## Bug Fixes
 
-<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
-
 ### Cookiecutter template
 
-<!-- Here bug fixes for cookiecutter specifically -->
+- docs: Fix typo in `docs/_css/style.css` ("annothations" -> "annotations")
+- ci: Fix the description of the arm64 `Dockerfile`

cookiecutter/{{cookiecutter.github_repo_name}}/.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile

@@ -2,8 +2,8 @@
 # Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
 {% raw -%}
 
-# This Dockerfile is used to run the tests in architectures not supported by
-# GitHub Actions.
+# This Dockerfile is used to run the tests in arm64, which is not supported by
+# GitHub Actions at the moment.
 
 FROM docker.io/library/ubuntu:20.04
 

cookiecutter/{{cookiecutter.github_repo_name}}/.github/workflows/ci.yaml

@@ -391,7 +391,7 @@ jobs:
         if: steps.mike-version.outputs.version
         run: |
           git checkout gh-pages
-          python -m frequenz.repo.config.cli.version.mkdocs.sort versions.json
+          python -m frequenz.repo.config.cli.version.mike.sort versions.json
           git commit -a -m "Sort versions.json"
 
       - name: Publish site

cookiecutter/{{cookiecutter.github_repo_name}}/docs/_css/style.css

@@ -29,7 +29,7 @@ a.external:hover::after, a.md-nav__link[href^="https:"]:hover::after {
 
 /* Code annotations with numbers.
  *
- * Normally annothations are shown with a (+) button that expands the
+ * Normally annotations are shown with a (+) button that expands the
  * annotation. To be able to explain code step by step, it is good to have
  * annotations with numbers, to be able to follow the notes in a particular
  * order.

docs/_css/style.css

@@ -29,7 +29,7 @@ a.external:hover::after, a.md-nav__link[href^="https:"]:hover::after {
 
 /* Code annotations with numbers.
  *
- * Normally annothations are shown with a (+) button that expands the
+ * Normally annotations are shown with a (+) button that expands the
  * annotation. To be able to explain code step by step, it is good to have
  * annotations with numbers, to be able to follow the notes in a particular
  * order.

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile

@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
-# This Dockerfile is used to run the tests in architectures not supported by
-# GitHub Actions.
+# This Dockerfile is used to run the tests in arm64, which is not supported by
+# GitHub Actions at the moment.
 
 FROM docker.io/library/ubuntu:20.04
 

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/.github/workflows/ci.yaml

@@ -363,7 +363,7 @@ jobs:
         if: steps.mike-version.outputs.version
         run: |
           git checkout gh-pages
-          python -m frequenz.repo.config.cli.version.mkdocs.sort versions.json
+          python -m frequenz.repo.config.cli.version.mike.sort versions.json
           git commit -a -m "Sort versions.json"
 
       - name: Publish site

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/docs/_css/style.css

@@ -29,7 +29,7 @@ a.external:hover::after, a.md-nav__link[href^="https:"]:hover::after {
 
 /* Code annotations with numbers.
  *
- * Normally annothations are shown with a (+) button that expands the
+ * Normally annotations are shown with a (+) button that expands the
  * annotation. To be able to explain code step by step, it is good to have
  * annotations with numbers, to be able to follow the notes in a particular
  * order.

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile

@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
-# This Dockerfile is used to run the tests in architectures not supported by
-# GitHub Actions.
+# This Dockerfile is used to run the tests in arm64, which is not supported by
+# GitHub Actions at the moment.
 
 FROM docker.io/library/ubuntu:20.04