-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Reworded the introduction of the contributing docs #7873
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
49dda37
326541a
f7078dc
008db10
56e51bb
8fd37db
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,30 @@ | ||
Contributing Documentation | ||
========================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
Documentation is as important as code for Open Source projects. That's why | ||
Symfony dedicates a great amount of resources to document new features and to | ||
keep the rest of the documentation up-to-date. | ||
|
||
More than 1,000 developers have contributed to Symfony documentation and we are | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [...] to the Symfony [...] There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Usually, we avoid the first person perspective. But here it matches quite well IMO. |
||
glad that you are considering joining this big family. This guide will explain | ||
everything you need to contribute to the documentation: | ||
|
||
:doc:`The Contribution Process </contributing/documentation/overview>` | ||
Explains the steps to follow to contribute fixes and new contents. It follows | ||
the standard GitHub contribution process of most Open Source projects, so you | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. open source? |
||
may already know everything that is needed. | ||
|
||
:doc:`Documentation Formats </contributing/documentation/format>` | ||
Explains the technical details of the reStructuredText format used to write | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [...] format that is used [...] |
||
the docs. Skip it if you already are familiar with this format. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [...] if you are already familiar [...] |
||
|
||
:doc:`Documentation Standards </contributing/documentation/standards>` | ||
Explains how to write docs and code examples to match the style and tone of | ||
the rest of the documentation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [...] of the existing documentation? |
||
|
||
overview | ||
format | ||
standards | ||
license | ||
:doc:`License </contributing/documentation/license>` | ||
Explains the details of the Creative Commons BB-SA 3.0 license used by the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. BY There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. used for? |
||
Symfony Documentation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. documentation |
||
|
||
.. toctree:: | ||
:hidden: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
Documentation Standards | ||
======================= | ||
|
||
In order to help the reader as much as possible and to create code examples that | ||
look and feel familiar, you should follow these standards. | ||
Contributions must follow these standards to match the style and tone of the | ||
rest of the Symfony Documentation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. documentation |
||
|
||
Sphinx | ||
------ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
Translations | ||
============ | ||
|
||
The Symfony documentation is not officially translated, though some community | ||
groups still maintain some translations. For more information, see `this blog post`_. | ||
The official Symfony documentation is published only in English, but some | ||
community groups maintain `unofficial translations`_. | ||
|
||
.. _`this blog post`: https://symfony.com/blog/discontinuing-the-symfony-community-translations | ||
.. _`unofficial translations`: https://symfony.com/blog/discontinuing-the-symfony-community-translations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
open source?