Skip to content

Commit c002784

Browse files
committed
Merge pull request symfony#1897 from dreipunktnull/updated_pull_request_info
Updated screenshot and information about changing base branch
2 parents 5ab63a7 + 827cffb commit c002784

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

contributing/documentation/overview.rst

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,14 @@ then clone your fork:
2525
2626
$ git clone git://github.com/YOURUSERNAME/symfony-docs.git
2727
28+
According to the framework's sources the documentation repository is split into
29+
three branches: ``2.0`` for the current Symfony 2.0.x release, ``2.1`` for the
30+
current Symfony 2.1.x release and ``master`` as the development branch for
31+
upcoming releases.
32+
2833
Unless you're documenting a feature that's new to Symfony 2.1, your changes
29-
should be based on the 2.0 branch instead of the master branch. To do this
30-
checkout the 2.0 branch before the next step:
34+
should always be based on the 2.0 branch instead of the master branch. To do
35+
this checkout the 2.0 branch before the next step:
3136

3237
.. code-block:: bash
3338
@@ -47,12 +52,17 @@ the ``symfony-docs`` ``master`` branch.
4752
.. image:: /images/docs-pull-request.png
4853
:align: center
4954

50-
If you have made your changes based on the 2.0 branch then you need to follow
51-
the change commit link and change the base branch to be @2.0:
55+
If you have made your changes based on the 2.0 branch then you need to change
56+
the base branch to be 2.0 on the preview page:
5257

5358
.. image:: /images/docs-pull-request-change-base.png
5459
:align: center
5560

61+
.. note::
62+
63+
All changes made to the 2.0 branch will be merged into 2.1 which in turn will be
64+
merged into the master branch for the next release on a weekly basis.
65+
5666
GitHub covers the topic of `pull requests`_ in detail.
5767

5868
.. note::
@@ -62,11 +72,11 @@ GitHub covers the topic of `pull requests`_ in detail.
6272

6373
.. tip::
6474

65-
Your changes appear on the symfony.com website no more than 15 minutes
66-
after the documentation team merges your pull request. You can check if
67-
your changes have introduced some markup issues by going to the
68-
`Documentation Build Errors`_ page (it is updated each French night at 3AM
69-
when the server rebuilds the documentation).
75+
Please be patient. It can take from 15 minutes to several days for your changes
76+
to appear on the symfony.com website after the documentation team merges your
77+
pull request. You can check if your changes have introduced some markup issues
78+
by going to the `Documentation Build Errors`_ page (it is updated each French
79+
night at 3AM when the server rebuilds the documentation).
7080

7181
Standards
7282
---------
9.17 KB
Loading

0 commit comments

Comments
 (0)