Skip to content

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

Closed
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contributing/documentation/format.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Documentation Format
====================

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

reStructuredText
Expand Down
29 changes: 23 additions & 6 deletions contributing/documentation/index.rst
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

open source?

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[...] to the Symfony [...]

Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The 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.
Copy link
Member

Choose a reason for hiding this comment

The 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.
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BY

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

used for?

Symfony Documentation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documentation


.. toctree::
:hidden:
Expand Down
28 changes: 7 additions & 21 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,16 @@
Contributing to the Documentation
=================================

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

More than 1,000 developers all around the world have contributed to Symfony's
documentation and we are glad that you are considering joining this big family.
This guide will explain everything you need to contribute to the Symfony
documentation.

Before Your First Contribution
------------------------------

**Before contributing**, you should consider the following:

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

* Sign up for a free `GitHub`_ account, which is the service where the Symfony
documentation is hosted.
* Be familiar with the `reStructuredText`_ markup language, which is used to
write Symfony docs. Read :doc:`this article </contributing/documentation/format>`
for a quick overview.

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

Expand Down
4 changes: 2 additions & 2 deletions contributing/documentation/standards.rst
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documentation


Sphinx
------
Expand Down
6 changes: 3 additions & 3 deletions contributing/documentation/translations.rst
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