diff --git a/docs/contribute.rst b/docs/contribute.rst index cc17654525..4bc091992c 100644 --- 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 index 7b7a036b37..2281333100 100644 --- 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