Skip to content

Commit 4c6b435

Browse files
committed
More simplifications
1 parent 870a3c1 commit 4c6b435

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

contributing/documentation/overview.rst

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Contributing to the Documentation
33

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

99
More than 1,000 developers all around the world have contributed to Symfony's
1010
documentation and we are glad that you are considering joining this big family.
@@ -17,15 +17,35 @@ Before Your First Contribution
1717
**Before contributing**, you should consider the following:
1818

1919
* Symfony documentation is written using `reStructuredText`_ markup language.
20-
If you are not familiar with this format, read :doc:`this article
21-
</contributing/documentation/format>` for a quick overview of its basic
22-
features.
20+
If you are not familiar with this format, read
21+
:doc:`this article </contributing/documentation/format>` for a quick overview
22+
of its basic features.
2323
* Symfony documentation is hosted on `GitHub`_. You'll need a free GitHub user
2424
account to contribute to the documentation.
2525
* Symfony documentation is published under a
2626
:doc:`Creative Commons BY-SA 3.0 License </contributing/documentation/license>`
2727
and all your contributions will implicitly adhere to that license.
2828

29+
Fast Online Contributions
30+
-------------------------
31+
32+
This method is best suited for small contributions, such as typos and rewordings.
33+
Due to GitHub's functional frontend, it is possible to create Pull Requests
34+
right in your browser while reading the docs on symfony.com.
35+
36+
First, switch to the oldest maintained Symfony branch which contains the error,
37+
which is usually ``2.3``. Then, click on the **edit this page** button on the
38+
upper right corner. Now edit the content and describe your changes within the
39+
GitHub frontend.
40+
41+
When your work is done, click **Propose file change** to create a commit and, in
42+
case it is your first contribution, also your fork. A new branch will be created
43+
automatically and you can then create the Pull Request.
44+
45+
If your contribution is large or if you prefer to work on your own computer,
46+
keep reading this guide to learn an alternative way to send pull requests to
47+
Symfony Documentation.
48+
2949
Your First Documentation Contribution
3050
-------------------------------------
3151

@@ -212,23 +232,6 @@ GitHub and click on ``Details``.
212232
Only Pull Requests to maintained branches are automatically built by
213233
Platform.sh. Check the `roadmap`_ for maintained branches.
214234

215-
Minor Changes (e.g. Typos)
216-
--------------------------
217-
218-
You may find just a typo and want to fix it. Due to GitHub's functional
219-
frontend, it is possible to create Pull Requests right in your browser while
220-
reading the docs on symfony.com.
221-
222-
First, switch to the oldest maintained Symfony branch which contains the error.
223-
Then, click on the **edit this page** button on the upper right corner. Now you
224-
are able to edit the content and describe your changes within the GitHub
225-
frontend.
226-
227-
When your work is done, click **Propose file change** to create a commit and, in
228-
case it is your first contribution, also your fork. A new branch is created
229-
automatically in order to provide a base for your Pull Request. Then fill out
230-
the form to create the Pull Request as described above.
231-
232235
Frequently Asked Questions
233236
--------------------------
234237

0 commit comments

Comments
 (0)