Skip to content

Commit 990b453

Browse files
committed
minor #4245 [Contributing] tweaks to the contribution chapter (xabbuh)
This PR was merged into the 2.3 branch. Discussion ---------- [Contributing] tweaks to the contribution chapter | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | Some tweaks for the changes made in #4223. @javiereguiluz Sorry, didn't find the time to review it in the first run. Commits ------- f4b0b8e tweaks to the contribution chapter
2 parents c2342a7 + f4b0b8e commit 990b453

File tree

2 files changed

+21
-25
lines changed

2 files changed

+21
-25
lines changed

Diff for: contributing/documentation/format.rst

+5-14
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,15 @@ roles to the standard reST markup. Read more about the `Sphinx Markup Constructs
3333
Syntax Highlighting
3434
~~~~~~~~~~~~~~~~~~~
3535

36-
PHP is the default syntax highlight applied to all code blocks. You can change
37-
it with the ``code-block`` directive:
36+
PHP is the default syntax highlighter applied to all code blocks. You can
37+
change it with the ``code-block`` directive:
3838

3939
.. code-block:: rst
4040
4141
.. code-block:: yaml
4242
4343
{ foo: bar, bar: { foo: bar, bar: baz } }
4444
45-
If your PHP code begins with ``<?php``, then you need to use ``html+php`` as
46-
the name of the highlighted syntax:
47-
48-
.. code-block:: rst
49-
50-
.. code-block:: html+php
51-
52-
<?php echo $this->foobar(); ?>
53-
5445
.. note::
5546

5647
Besides all of the major programming languages, the syntax highlighter
@@ -183,7 +174,7 @@ If you're documenting a brand new feature or a change that's been made in
183174
Symfony, you should precede your description of the change with a
184175
``.. versionadded:: 2.X`` directive and a short description:
185176

186-
.. code-block:: text
177+
.. code-block:: rst
187178
188179
.. versionadded:: 2.3
189180
The ``askHiddenResponse`` method was introduced in Symfony 2.3.
@@ -193,7 +184,7 @@ Symfony, you should precede your description of the change with a
193184
If you're documenting a behavior change, it may be helpful to *briefly* describe
194185
how the behavior has changed.
195186

196-
.. code-block:: text
187+
.. code-block:: rst
197188
198189
.. versionadded:: 2.3
199190
The ``include()`` function is a new Twig feature that's available in
@@ -204,7 +195,7 @@ a new branch of the documentation is created from the ``master`` branch.
204195
At this point, all the ``versionadded`` tags for Symfony versions that have
205196
reached end-of-life will be removed. For example, if Symfony 2.5 were released
206197
today, and 2.2 had recently reached its end-of-life, the 2.2 ``versionadded``
207-
tags would be removed from the new 2.5 branch.
198+
tags would be removed from the new ``2.5`` branch.
208199

209200
Testing Documentation
210201
~~~~~~~~~~~~~~~~~~~~~

Diff for: contributing/documentation/overview.rst

+16-11
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ Contributing to the Documentation
33

44
One of the essential principles of the Symfony project is that **documentation is
55
as important as code**. That's why a great amount of resources are dedicated to
6-
documenting new features and to keeping the rest of the documentation up to date.
6+
documenting new features and to keeping the rest of the documentation up-to-date.
77

8-
More than 800 developers all around the world have contributed to Symfony's
9-
documentation, and we are glad that you are considering joining this big family.
8+
More than 700 developers all around the world have contributed to Symfony's
9+
documentation and we are glad that you are considering joining this big family.
1010
This guide will explain everything you need to contribute to the Symfony
1111
documentation.
1212

@@ -27,9 +27,9 @@ Before Your First Contribution
2727
Your First Documentation Contribution
2828
-------------------------------------
2929

30-
In this section you'll learn how to contribute to the Symfony documentation for
30+
In this section, you'll learn how to contribute to the Symfony documentation for
3131
the first time. The next section will explain the shorter process you'll follow
32-
in the future for every contribution after your first.
32+
in the future for every contribution after your first one.
3333

3434
Let's imagine that you want to improve the installation chapter of the Symfony
3535
book. In order to make your changes, follow these steps:
@@ -164,8 +164,12 @@ Now you can **sync your fork** by executing the following command:
164164
165165
$ cd projects/symfony-docs/
166166
$ git fetch upstream
167-
$ git checkout master
168-
$ git merge upstream/master
167+
$ git checkout 2.3
168+
$ git merge upstream/2.3
169+
170+
This command will update the ``2.3`` branch, which is the one you used to
171+
create the new branch for your changes. If have used another base branch,
172+
e.g. ``master``, replace the ``2.3`` with the appropriate branch name.
169173

170174
Great! Now you can proceed by following the same steps explained in the previous
171175
section:
@@ -212,8 +216,8 @@ steps to contribute to the Symfony documentation, which you can use as a
212216
# sync your fork with the official Symfony repository
213217
$ cd projects/symfony-docs/
214218
$ git fetch upstream
215-
$ git checkout master
216-
$ git merge upstream/master
219+
$ git checkout 2.3
220+
$ git merge upstream/2.3
217221
218222
# create a new branch from the oldest maintained version
219223
$ git checkout 2.3
@@ -262,10 +266,11 @@ Why Should I Use the Oldest Maintained Branch Instead of the Master Branch?
262266

263267
Consistent with Symfony's source code, the documentation repository is split
264268
into multiple branches, corresponding to the different versions of Symfony itself.
265-
The master branch holds the documentation for the development branch of the code.
269+
The ``master`` branch holds the documentation for the development branch of
270+
the code.
266271

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

0 commit comments

Comments
 (0)