8000 minor #20726 Update overview.rst (mmauksch) · ThomasLandauer/symfony-docs@a78ddb2 · GitHub
[go: up one dir, main page]

Skip to content

Commit a78ddb2

Browse files
committed
minor symfony#20726 Update overview.rst (mmauksch)
This PR was merged into the 6.4 branch. Discussion ---------- Update overview.rst Update version numbers to currently last maintained version (According to overview in the Releases Page). Intent is to make it clearer and also easier for users using Copy-Paste for git commands. Description in the github screenshot intentionally changed to 4.4 to avoid confusion between picture and description (replacing the screenshot seemed excessive) Commits ------- fdb7a29 Update overview.rst
2 parents 36280dd + fdb7a29 commit a78ddb2

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

contributing/documentation/overview.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,16 +113,16 @@ memorable name for the new branch (if you are fixing a reported issue, use
113113

114114
.. code-block:: terminal
115115
116-
$ git checkout -b improve_install_article upstream/5.4
116+
$ git checkout -b improve_install_article upstream/6.4
117117
118118
In this example, the name of the branch is ``improve_install_article`` and the
119-
``upstream/5.4`` value tells Git to create this branch based on the ``5.4``
119+
``upstream/6.4`` value tells Git to create this branch based on the ``6.4``
120120
branch of the ``upstream`` remote, which is the original Symfony Docs repository.
121121

122122
Fixes should always be based on the **oldest maintained branch** which contains
123-
the error. Nowadays this is the ``5.4`` branch. If you are instead documenting a
123+
the error. Nowadays this is the ``6.4`` branch. If you are instead documenting a
124124
new feature, switch to the first Symfony version that included it, e.g.
125-
``upstream/6.2``.
125+
``upstream/7.2``.
126126

127127
**Step 5.** Now make your changes in the documentation. Add, tweak, reword and
128128
even remove any content and do your best to comply with the
@@ -156,7 +156,7 @@ changes should be applied:
156156
:alt: The base branch select option on the GitHub page.
157157

158158
In this example, the **base fork** should be ``symfony/symfony-docs`` and
159-
the **base** branch should be the ``5.4``, which is the branch that you selected
159+
the **base** branch should be the ``4.4``, which is the branch that you selected
160160
to base your changes on. The **head fork** should be your forked copy
161161
of ``symfony-docs`` and the **compare** branch should be ``improve_install_article``,
162162
which is the name of the branch you created and where you made your changes.
@@ -209,7 +209,7 @@ contribution to the Symfony docs:
209209
# create a new branch based on the oldest maintained version
210210
$ cd projects/symfony-docs/
211211
$ git fetch upstream
212-
$ git checkout -b my_changes upstream/5.4
212+
$ git checkout -b my_changes upstream/6.4
213213
214214
# ... do your changes
215215
@@ -258,8 +258,8 @@ into multiple branches, corresponding to the different versions of Symfony itsel
258258
The latest (e.g. ``5.x``) branch holds the documentation for the development branch of
259259
the code.
260260

261-
Unless you're documenting a feature that was introduced after Symfony 5.4,
262-
your changes should always be based on the ``5.4`` branch. Documentation managers
261+
Unless you're documenting a feature that was introduced after Symfony 6.4,
262+
your changes should always be based on the ``6.4`` branch. Documentation managers
263263
will use the necessary Git-magic to also apply your changes to all the active
264264
branches of the documentation.
265265

0 commit comments

Comments
 (0)
0