Mention the docs best practices in the release notes

teemtee · Jul 19, 2024 · 88b6434 · 88b6434
1 parent 381f7d3
commit 88b6434
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/contribute.rst b/docs/contribute.rst
@@ -343,6 +343,8 @@ To remove these images from your local system, run the following:
     make clean-test-images
 
 
+.. _docs:
+
 Docs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/releases.rst b/docs/releases.rst
@@ -8,6 +8,10 @@
 tmt-1.35
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+New best practices in the :ref:`docs` section now provide many
+useful hints how to write good documentation when contributing
+code.
+
 The new key ``include-output-log`` and corresponding command line
 options ``--include-output-log`` and ``--no-include-output-log``
 can now be used in the :ref:`plugins/report/junit` and