Skip to content

Commit 74dd291

Browse files
committed
Clarify text when referring to a released version in the docs
Depending on the context of releases, active docs can be only the current LTR docs or we can have both the LTR docs and the docs for the next one. Let's then use dedicated substitutions to avoid confusion.
1 parent 3058a9b commit 74dd291

5 files changed

Lines changed: 17 additions & 9 deletions

File tree

docs/about/contributors.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ The current translations are made possible thanks to:
125125
Statistics of translation
126126
=========================
127127

128-
Efforts of translation for QGIS |CURRENT| Long Term Release are provided below.
128+
Efforts of translation for QGIS |ltr| Long Term Release are provided below.
129129
Official documentation is published in only the languages that reached 5% of translation.
130130

131131
.. include:: translation_stats.rst
@@ -138,4 +138,4 @@ The current translations are made possible thanks to:
138138
please add it also to the substitutions.txt file in the
139139
source folder.
140140
141-
.. |CURRENT| replace:: 3.44
141+
.. |ltr| replace:: 3.44

docs/about/preamble.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,19 @@ What is new in QGIS |version|
5858
-----------------------------
5959

6060
This release of QGIS includes hundreds of bug fixes and many new
61-
features and enhancements, compared to |QGIS_CURRENT|_.
61+
features and enhancements, compared to QGIS |previous_docs|.
6262
For a list of new features, visit the `visual changelogs
6363
<https://qgis.org/project/visual-changelogs/>`_.
6464

6565
.. only:: not testing and not outdated
6666

6767
We recommend that you use this version over previous releases.
6868

69-
.. |QGIS_CURRENT| replace:: QGIS 3.40
70-
.. _QGIS_CURRENT: https://docs.qgis.org/3.40/en/docs/
69+
70+
.. Substitutions definitions - AVOID EDITING PAST THIS LINE
71+
This will be automatically updated by the find_set_subst.py script.
72+
If you need to create a new substitution manually,
73+
please add it also to the substitutions.txt file in the
74+
source folder.
75+
76+
.. |previous_docs| replace:: 3.44

docs/user_manual/grass_integration/grass_integration.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@ The GRASS plugin provides a user-friendly toolbox with about 200 of the availabl
592592
GRASS modules and functionalities.
593593

594594
A complete list of GRASS modules available in the graphical Toolbox in QGIS
595-
version |CURRENT| is available in the GRASS wiki at
595+
is available in the GRASS wiki at
596596
https://grasswiki.osgeo.org/wiki/GRASS-QGIS_relevant_module_list.
597597

598598
It is also possible to customize the GRASS Toolbox content. This procedure is
@@ -843,7 +843,6 @@ you select the module.
843843
please add it also to the substitutions.txt file in the
844844
source folder.
845845
846-
.. |CURRENT| replace:: 3.44
847846
.. |captureBoundary| image:: /static/common/mActionCaptureBoundary.png
848847
:width: 1.5em
849848
.. |captureCentroid| image:: /static/common/mActionCaptureCentroid.png

release_process.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ This usually happens from the October release.
3939
Following changes have to be done in `master` branch before you create the new release branch.
4040
Otherwise, you will have to do the changes twice: in master and in the new branch.
4141

42-
- [ ] In [substitutions.txt](substitutions.txt) file, replace |CURRENT| value with the new version number
4342
- [ ] In [docs_conf.yml](docs_conf.yml) file: add the new release number to the `version_list` parameter
4443
- [ ] In [dependabot.yml](.github/dependabot.yml) file: Add label for backporting dependencies update to the new branch
4544

4645
You can now create the `release_x.y` branch in the [repository](https://github.com/qgis/QGIS-Documentation/branches), based on `master`.
4746

4847
#### After the new branch is created
4948

49+
- [ ] In [substitutions.txt](substitutions.txt) file, replace |previous_docs| value with the new version number
5050
- [ ] In [substitutions.txt](substitutions.txt) file:
5151
- [ ] Remove intermediate versions substitutions and their occurrences in the rst files
5252
- [ ] Add substitutions for the versions of the next LTR cycle that starts
@@ -127,6 +127,7 @@ In February, the new version is labeled as LTR, and replaces the previous one in
127127
<details>
128128

129129
- [ ] In [conf.py](conf.py) file: set the html_context `isLtr` to `True`
130+
- [ ] In [substitutions.txt](substitutions.txt) file, replace |ltr| value with the new LTR version number
130131
- [ ] In [docs_conf.yml](docs_conf.yml) file: add target languages to the `supported_languages` parameter.
131132
These are the languages that will be published in the documentation.
132133
A threshold of 5% is currently applied to candidates.
@@ -158,6 +159,7 @@ is being translated. So when a new LTR is published, we disconnect the old one a
158159

159160
<details>
160161

162+
- [ ] In [substitutions.txt](substitutions.txt) file, replace |ltr| value with the new LTR version number
161163
- [ ] In [fix_versions.sh](scripts/fix_versions.sh) file:
162164
- [ ] add the old LTR number to the `DEPRECATED` parameter
163165
- [ ] add the new LTR number to the `DOCVERSIONS` parameter

substitutions.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33

44
# Text replacement
55

6-
.. |CURRENT| replace:: 3.44
76
.. |largeLandUseArea| replace:: Bontebok National Park
7+
.. |ltr| replace:: 3.44
88
.. |majorUrbanName| replace:: Swellendam
99
.. |schoolAreaType1| replace:: athletics field
1010
.. |srtmFileName| replace:: :file:`srtm_41_19_4326.tif`
11+
.. |previous_docs| replace:: 3.44
1112

1213
# Icons replacement
1314

0 commit comments

Comments
 (0)