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

Commit46a9d6e

Browse files
committed
tweaks to the contribution chapter
1 parent2319d6a commit46a9d6e

File tree

2 files changed

+22
-18
lines changed

2 files changed

+22
-18
lines changed

‎contributing/documentation/format.rst‎

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,15 @@ roles to the standard reST markup. Read more about the `Sphinx Markup Constructs
3333
Syntax Highlighting
3434
~~~~~~~~~~~~~~~~~~~
3535

36-
PHP is the default syntaxhighlight applied to all code blocks. You can change
37-
it with the ``code-block`` directive:
36+
PHP is the default syntaxhighlighter applied to all code blocks. You can
37+
changeit with the ``code-block`` directive:
3838

3939
..code-block::rst
4040
4141
.. code-block:: yaml
4242
4343
{ foo: bar, bar: { foo: bar, bar: baz } }
4444
45-
If your PHP code begins with ``<?php``, then you need to use ``html+php`` as
46-
the name of the highlighted syntax:
47-
48-
..code-block::rst
49-
50-
.. code-block:: html+php
51-
52-
<?php echo $this->foobar(); ?>
53-
5445
..note::
5546

5647
Besides all of the major programming languages, the syntax highlighter
@@ -183,7 +174,7 @@ If you're documenting a brand new feature or a change that's been made in
183174
Symfony, you should precede your description of the change with a
184175
``.. versionadded:: 2.X`` directive and a short description:
185176

186-
..code-block::text
177+
..code-block::rst
187178
188179
.. versionadded:: 2.3
189180
The ``askHiddenResponse`` method was introduced in Symfony 2.3.
@@ -193,7 +184,7 @@ Symfony, you should precede your description of the change with a
193184
If you're documenting a behavior change, it may be helpful to *briefly* describe
194185
how the behavior has changed.
195186

196-
..code-block::text
187+
..code-block::rst
197188
198189
.. versionadded:: 2.3
199190
The ``include()`` function is a new Twig feature that's available in

‎contributing/documentation/overview.rst‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ Contributing to the Documentation
33

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

8-
More than800 developers all around the world have contributed to Symfony's
9-
documentation, and we are glad that you are considering joining this big family.
8+
More than700 developers all around the world have contributed to Symfony's
9+
documentation and we are glad that you are considering joining this big family.
1010
This guide will explain everything you need to contribute to the Symfony
1111
documentation.
1212

@@ -27,9 +27,9 @@ Before Your First Contribution
2727
Your First Documentation Contribution
2828
-------------------------------------
2929

30-
In this section you'll learn how to contribute to the Symfony documentation for
30+
In this section, you'll learn how to contribute to the Symfony documentation for
3131
the first time. The next section will explain the shorter process you'll follow
32-
in the future for every contribution after your first.
32+
in the future for every contribution after your first one.
3333

3434
Let's imagine that you want to improve the installation chapter of the Symfony
3535
book. In order to make your changes, follow these steps:
@@ -167,6 +167,19 @@ Now you can **sync your fork** by executing the following command:
167167
$ git checkout master
168168
$ git merge upstream/master
169169
170+
..note::
171+
172+
If you are documenting a feature based on another branch than master,
173+
you'll also have to sync that branch. For example, if your changes will
174+
be based on the 2.3 branch, execute the following commands:
175+
176+
..code-block::bash
177+
178+
$cd projects/symfony-docs/
179+
$ git fetch upstream
180+
$ git checkout 2.3
181+
$ git merge upstream/2.3
182+
170183
Great! Now you can proceed by following the same steps explained in the previous
171184
section:
172185

0 commit comments

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