Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Update overview.rst #20726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions 16 contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,16 @@ memorable name for the new branch (if you are fixing a reported issue, use

.. code-block:: terminal

$ git checkout -b improve_install_article upstream/5.4
$ git checkout -b improve_install_article upstream/6.4

In this example, the name of the branch is ``improve_install_article`` and the
``upstream/5.4`` value tells Git to create this branch based on the ``5.4``
``upstream/6.4`` value tells Git to create this branch based on the ``6.4``
branch of the ``upstream`` remote, which is the original Symfony Docs repository.

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

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

In this example, the **base fork** should be ``symfony/symfony-docs`` and
the **base** branch should be the ``5.4``, which is the branch that you selected
the **base** branch should be the ``4.4``, which is the branch that you selected
xabbuh marked this conversation as resolved.
Show resolved Hide resolved
to base your changes on. The **head fork** should be your forked copy
of ``symfony-docs`` and the **compare** branch should be ``improve_install_article``,
which is the name of the branch you created and where you made your changes.
Expand Down Expand Up @@ -209,7 +209,7 @@ contribution to the Symfony docs:
# create a new branch based on the oldest maintained version
$ cd projects/symfony-docs/
$ git fetch upstream
$ git checkout -b my_changes upstream/5.4
$ git checkout -b my_changes upstream/6.4

# ... do your changes

Expand Down Expand Up @@ -258,8 +258,8 @@ into multiple branches, corresponding to the different versions of Symfony itsel
The latest (e.g. ``5.x``) branch holds the documentation for the development branch of
the code.

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

Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.