@@ -25,9 +25,14 @@ then clone your fork:
25
25
26
26
$ git clone git://github.com/YOURUSERNAME/symfony-docs.git
27
27
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
+
28
33
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:
31
36
32
37
.. code-block :: bash
33
38
@@ -47,12 +52,17 @@ the ``symfony-docs`` ``master`` branch.
47
52
.. image :: /images/docs-pull-request.png
48
53
:align: center
49
54
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 :
52
57
53
58
.. image :: /images/docs-pull-request-change-base.png
54
59
:align: center
55
60
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
+
56
66
GitHub covers the topic of `pull requests `_ in detail.
57
67
58
68
.. note ::
@@ -62,11 +72,11 @@ GitHub covers the topic of `pull requests`_ in detail.
62
72
63
73
.. tip ::
64
74
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).
70
80
71
81
Standards
72
82
---------
0 commit comments