Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit9bcd33d

Browse files
committed
More and more fixes and improvements
1 parent15f3c94 commit9bcd33d

File tree

4 files changed

+28
-19
lines changed

4 files changed

+28
-19
lines changed

‎contributing/documentation/format.rst‎

Lines changed: 9 additions & 8 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 usesreStructuredText_ 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
@@ -12,7 +12,7 @@ reStructuredText is a plaintext markup syntax similar to Markdown, but much
1212
stricter with its syntax. If you are new to reStructuredText, take some time to
1313
familiarize with this format by reading the existing `Symfony documentation`_
1414

15-
If youprefer to learn more about this format, check out the `reStructuredText Primer`_
15+
If youwant to learn more about this format, check out the `reStructuredText Primer`_
1616
tutorial and the `reStructuredText Reference`_.
1717

1818
..caution::
@@ -64,7 +64,7 @@ Configuration Blocks
6464

6565
Whenever you include a configuration sample, use the ``configuration-block``
6666
directive to show the configuration in all supported configuration formats
67-
(``PHP``, ``YAML``, and ``XML``). Example:
67+
(``PHP``, ``YAML`` and ``XML``). Example:
6868

6969
..code-block::rst
7070
@@ -146,7 +146,8 @@ If you want to modify that title, use this alternative syntax:
146146
..note::
147147

148148
Although they are technically correct, avoid the use of relative internal
149-
links such as the following:
149+
links such as the following, because they break the references in the
150+
generated PDF documentation:
150151

151152
..code-block::rst
152153
@@ -217,13 +218,13 @@ free of syntax errors and is ready to be reviewed.
217218
Nevertheless, if you prefer to do this check locally on your own machine before
218219
submitting your documentation, follow these steps:
219220

220-
* Install`Sphinx`_;
221+
* InstallSphinx_;
221222
* Install the Sphinx extensions using git submodules: ``$ git submodule update --init``;
222223
* (Optionally) Install the bundle docs and CMF docs: ``$ bash install.sh``;
223224
* Run ``make html`` and view the generated HTML in the ``build/`` directory.
224225

225-
.._`reStructuredText`:http://docutils.sourceforge.net/rst.html
226-
.._`Sphinx`:http://sphinx-doc.org/
226+
.._reStructuredText:http://docutils.sourceforge.net/rst.html
227+
.._Sphinx:http://sphinx-doc.org/
227228
.. _`Symfony documentation`:https://github.com/symfony/symfony-docs
228229
.. _`reStructuredText Primer`:http://sphinx-doc.org/rest.html
229230
.. _`reStructuredText Reference`:http://docutils.sourceforge.net/docs/user/rst/quickref.html

‎contributing/documentation/overview.rst‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ Before Your First Contribution
1414

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

17-
* Symfony documentation is written using`reStructuredText`_ markup language.
17+
* Symfony documentation is written usingreStructuredText_ markup language.
1818
If you are not familiar with this format, read:doc:`this article</contributing/documentation/format>`
1919
for a quick overview of its basic features.
20-
* Symfony documentation is hosted on`GitHub`_. You'll need a GitHub user account
20+
* Symfony documentation is hosted onGitHub_. You'll need a GitHub user account
2121
to contribute documentation.
2222
* Symfony documentation is published under a
2323
:doc:`Creative Commons BY-SA 3.0 License</contributing/documentation/license>`
@@ -137,7 +137,7 @@ changes and push them:
137137
138138
**Step 10.** After your pull request is eventually accepted and merged in the Symfony
139139
documentation, you will be included in the `Symfony Documentation Contributors`_
140-
list. Moreover, if you happen to have a`SensioLabsConnect`_ profile, you will
140+
list. Moreover, if you happen to have aSensioLabsConnect_ profile, you will
141141
get a cool `Symfony Documentation Badge`_.
142142

143143
Your Second Documentation Contribution
@@ -286,16 +286,17 @@ which is the state of your work:
286286
Would You Admit a Huge Pull Request with Lots of Changes?
287287
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
288288

289-
Sure! But before doing a huge change, it's probably a good idea to open an issue
290-
in the Symfony Documentation repository to ask the managers if they agree with
291-
your proposed changes. Otherwise, they could refuse your proposal after having
292-
made all the work and you would have wasted a lot of time.
289+
First, make sure that the changes are somewhat related. Otherwise, please create
290+
separate pull requests. Anyway, before submitting a huge change, it's probably a
291+
good idea to open an issue in the Symfony Documentation repository to ask the
292+
managers if they agree with your proposed changes. Otherwise, they could refuse
293+
your proposal after having made all the work and you would have wasted a lot of time.
293294

294295
.. _`github.com/symfony/symfony-docs`:https://github.com/symfony/symfony-docs
295-
.._`reStructuredText`:http://docutils.sourceforge.net/rst.html
296-
.._`GitHub`:https://github.com/
296+
.._reStructuredText:http://docutils.sourceforge.net/rst.html
297+
.._GitHub:https://github.com/
297298
.. _`fork the repository`:https://help.github.com/articles/fork-a-repo
298299
.. _`Symfony Documentation Contributors`:http://symfony.com/contributors/doc
299-
.._`SensioLabsConnect`:https://connect.sensiolabs.com/
300+
.._SensioLabsConnect:https://connect.sensiolabs.com/
300301
.. _`Symfony Documentation Badge`:https://connect.sensiolabs.com/badge/36/symfony-documentation-contributor
301302
.. _`sync your fork`:https://help.github.com/articles/syncing-a-fork

‎contributing/documentation/standards.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ English Language Standards
140140
* **English Dialect**: use the United States English dialect, commonly called
141141
`American English`_.
142142
* **Section titles**: use a variant of the title case, where the first
143-
word is always capitalized, and all other words are capitalized, except for
143+
word is always capitalized and all other words are capitalized, except for
144144
the closed-class words (read Wikipedia article about `headings and titles`_).
145145

146146
E.g.: The Vitamins are in my Fresh California Raisins

‎contributing/documentation/translations.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ Translations
44
The Symfony2 documentation is written in English and many people are involved
55
in the translation process.
66

7+
..note::
8+
9+
Symfony Project officially discourages starting new translations for the
10+
documentation. As a matter of fact, there is `an ongoing discussion`_ in
11+
the community about the benefits and drawbacks of community driven translations.
12+
713
Contributing
814
------------
915

@@ -84,4 +90,5 @@ repository and apply changes to the translated documents as soon as possible.
8490
Non maintained languages are removed from the official list of
8591
repositories as obsolete documentation is dangerous.
8692

93+
.. _`an ongoing discussion`:https://github.com/symfony/symfony-docs/issues/4078
8794
.. _Symfony docs mailing-list:http://groups.google.com/group/symfony-docs

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp