Skip to content

Commit 0c754fa

Browse files
committed
minor #7873 Reworded the introduction of the contributing docs (javiereguiluz)
This PR was squashed before being merged into the 2.7 branch (closes #7873). Discussion ---------- Reworded the introduction of the contributing docs I propose a more gentle and actionable introduction to the "contributing docs" guide. The current introduction is confusing and intimidating to newcomers: ![contributing-index](https://cloud.githubusercontent.com/assets/73419/25700725/3afaea3e-30c9-11e7-8237-2734986ab93a.png) Commits ------- 6e23024 Reworded the introduction of the contributing docs
2 parents 290eb49 + 6e23024 commit 0c754fa

File tree

5 files changed

+32
-34
lines changed

5 files changed

+32
-34
lines changed

contributing/documentation/format.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Documentation Format
22
====================
33

4-
The Symfony documentation uses reStructuredText_ as its markup language and
5-
Sphinx_ for generating the documentation in the formats read by the end users,
4+
The Symfony documentation uses `reStructuredText`_ as its markup language and
5+
`Sphinx`_ for generating the documentation in the formats read by the end users,
66
such as HTML and PDF.
77

88
reStructuredText

contributing/documentation/index.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
Contributing Documentation
22
==========================
33

4-
.. toctree::
5-
:maxdepth: 2
4+
These short articles explain everything you need to contribute to the Symfony
5+
documentation:
6+
7+
:doc:`The Contribution Process </contributing/documentation/overview>`
8+
Explains the steps to follow to contribute fixes and new contents. It's the
9+
same contribution process followed by most open source projects, so you may
10+
already know everything that is needed.
11+
12+
:doc:`Documentation Formats </contributing/documentation/format>`
13+
Explains the technical details of the reStructuredText format that is used to
14+
write the docs. Skip it if you are already familiar with this format.
15+
16+
:doc:`Documentation Standards </contributing/documentation/standards>`
17+
Explains how to write docs and code examples to match the style and tone of
18+
the rest of the existing documentation.
619

7-
overview
8-
format
9-
standards
10-
license
20+
:doc:`License </contributing/documentation/license>`
21+
Explains the details of the Creative Commons BY-SA 3.0 license used for the
22+
Symfony Documentation.
1123

1224
.. toctree::
1325
:hidden:

contributing/documentation/overview.rst

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,16 @@
11
Contributing to the Documentation
22
=================================
33

4-
One of the essential principles of the Symfony project is that **documentation
5-
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
7-
up-to-date.
8-
9-
More than 1,000 developers all around the world have contributed to Symfony's
10-
documentation and we are glad that you are considering joining this big family.
11-
This guide will explain everything you need to contribute to the Symfony
12-
documentation.
13-
144
Before Your First Contribution
155
------------------------------
166

17-
**Before contributing**, you should consider the following:
18-
19-
* Symfony documentation is written using `reStructuredText`_ markup language.
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.
23-
* Symfony documentation is hosted on `GitHub`_. You'll need a free GitHub user
24-
account to contribute to the documentation.
25-
* Symfony documentation is published under a
26-
:doc:`Creative Commons BY-SA 3.0 License </contributing/documentation/license>`
27-
and all your contributions will implicitly adhere to that license.
7+
**Before contributing**, you need to:
8+
9+
* Sign up for a free `GitHub`_ account, which is the service where the Symfony
10+
documentation is hosted.
11+
* Be familiar with the `reStructuredText`_ markup language, which is used to
12+
write Symfony docs. Read :doc:`this article </contributing/documentation/format>`
13+
for a quick overview.
2814

2915
.. _minor-changes-e-g-typos:
3016

contributing/documentation/standards.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Documentation Standards
22
=======================
33

4-
In order to help the reader as much as possible and to create code examples that
5-
look and feel familiar, you should follow these standards.
4+
Contributions must follow these standards to match the style and tone of the
5+
rest of the Symfony documentation.
66

77
Sphinx
88
------
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Translations
22
============
33

4-
The Symfony documentation is not officially translated, though some community
5-
groups still maintain some translations. For more information, see `this blog post`_.
4+
The official Symfony documentation is published only in English, but some
5+
community groups maintain `unofficial translations`_.
66

7-
.. _`this blog post`: https://symfony.com/blog/discontinuing-the-symfony-community-translations
7+
.. _`unofficial translations`: https://symfony.com/blog/discontinuing-the-symfony-community-translations

0 commit comments

Comments
 (0)