Skip to content

Commit 03d561e

Browse files
committed
Merge branch '2.8' into 3.4
* 2.8: added mentoring and speaker mentoring sections Fix translation debug examples Add note about configuration root node
2 parents 5253488 + 8b38223 commit 03d561e

File tree

6 files changed

+77
-12
lines changed

6 files changed

+77
-12
lines changed

bundles/configuration.rst

+15-9
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,9 @@ as integration of other related components:
5757
Using the Bundle Extension
5858
--------------------------
5959

60-
The basic idea is that instead of having the user override individual
61-
parameters, you let the user configure just a few, specifically created,
62-
options. As the bundle developer, you then parse through that configuration and
63-
load correct services and parameters inside an "Extension" class.
64-
65-
As an example, imagine you are creating a social bundle, which provides
66-
integration with Twitter and such. To be able to reuse your bundle, you have to
67-
make the ``client_id`` and ``client_secret`` variables configurable. Your
68-
bundle configuration would look like:
60+
Imagine you are creating a new bundle - AcmeSocialBundle - which provides
61+
integration with Twitter, etc. To make your bundle easy to use, you want to
62+
allow users to configure it with some configuration that looks like this:
6963

7064
.. configuration-block::
7165

@@ -102,6 +96,17 @@ bundle configuration would look like:
10296
'client_secret' => 'your_secret',
10397
));
10498
99+
The basic idea is that instead of having the user override individual
100+
parameters, you let the user configure just a few, specifically created,
101+
options. As the bundle developer, you then parse through that configuration and
102+
load correct services and parameters inside an "Extension" class.
103+
104+
.. note::
105+
106+
The root key of your bundle configuration (``acme_social`` in the previous
107+
example) is automatically determined from your bundle name (it's the
108+
`snake case`_ of the bundle name without the ``Bundle`` suffix ).
109+
105110
.. seealso::
106111

107112
Read more about the extension in :doc:`/bundles/extension`.
@@ -439,3 +444,4 @@ Assuming the XSD file is called ``hello-1.0.xsd``, the schema location will be
439444
.. _`TwigBundle Configuration`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/TwigBundle/DependencyInjection/Configuration.php
440445
.. _`XML namespace`: https://en.wikipedia.org/wiki/XML_namespace
441446
.. _`XML schema`: https://en.wikipedia.org/wiki/XML_schema
447+
.. _`snake case`: https://en.wikipedia.org/wiki/Snake_case

contributing/community/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ Community
77
releases
88
review-comments
99
reviews
10+
mentoring
11+
speaker-mentoring
1012
other

contributing/community/mentoring.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Mentoring
2+
=========
3+
4+
Reading the :doc:`contributing </contributing/index>` is already a great way
5+
to get started on becoming a Symfony contributor. However, sometimes
6+
it might still seem overwhelming - contributing can be complex! For this
7+
purpose we created a dedicated `Symfony Slack`_ channel called `#mentoring`_
8+
to connect new contributors to long-time contributors. This is a great way
9+
to get one-on-one advice on the entire process. These long-time contributors
10+
do really want to help new contributors - so feel free to ask anything!
11+
12+
.. _`Symfony Slack`: https://symfony.com/slack-invite
13+
.. _`#mentoring`: https://symfony-devs.slack.com/messages/mentoring
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Speaker Mentoring
2+
=================
3+
4+
The Symfony community benefits greatly when as many people as possible
5+
share their knowledge and experience with others. Every different
6+
point of view adds to our collective understanding of how to best use
7+
and evolve the code, design patterns and architecture provided within
8+
the Symfony community. Because of this, we specifically want to hear
9+
from long-time contributors and new users, who often come across entirely
10+
different challenges with a totally fresh new look and perspective.
11+
12+
How to get started
13+
------------------
14+
15+
Giving a first talk at a conference can seem quite intimidating. But
16+
don't worry! At one time, every speaker went through the same process.
17+
And so, we want to make sure that as many people as possible are empowered
18+
to take this path if they are motivated. We have collected a few resources
19+
with advice to get started. More importantly, we can connect experienced
20+
speakers with people who are just taking their first steps in this area:
21+
22+
.. tip::
23+
24+
A good first step might be to give a talk at a local user group to a
25+
smaller crowd that one knows more intimately. A next step could be to
26+
give a talk at conference in your first language.
27+
28+
The best way to find people that can review your talk idea or slides is
29+
the `#speaker-mentoring`_ channel on `Symfony Slack`_. There are many
30+
seasoned speakers with knowledge in various parts of Symfony that are
31+
motivated to help you get started on your path towards becoming a
32+
public speaker. They can even do practice runs via video chat!
33+
Furthermore, they can also be an ally when it comes to the day of
34+
giving the talk at a conference!
35+
36+
A great resource with advice on everything related to`public speaking`_
37+
is a collection of links maintained by VM (Vicky) Brasseur. It covers
38+
everything from finding a conference call for proposals, how to
39+
refine a proposal, to how to put together slide decks to practical
40+
tips for preparation and talk delivery.
41+
42+
.. _`#speaker-mentoring`: https://symfony-devs.slack.com/messages/speaker-mentoring
43+
.. _`Symfony Slack`: https://symfony.com/slack-invite
44+
.. _`public speaking`: https://github.com/vmbrasseur/Public_Speaking

setup/built_in_web_server.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ can change the socket passing an IP address and a port as a command-line argumen
8989
9090
$ php bin/console server:status 192.168.0.1:8080
9191
92-
The first command shows if your Symfony application will be server through
92+
The first command shows if your Symfony application will be served through
9393
``localhost:8000``, the second one does the same for ``192.168.0.1:8080``.
9494

9595
.. tip::

translation/debug.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ for the ``fr`` locale and run the command, you will get:
152152
--------- ------------------ ---------------------- -------------------------------
153153
State Id Message Preview (fr) Fallback Message Preview (en)
154154
--------- ------------------ ---------------------- -------------------------------
155-
missing Symfony is great J'aime Symfony Symfony is great
155+
missing Symfony is great Symfony is great Symfony is great
156156
--------- ------------------ ---------------------- -------------------------------
157157
158158
The state indicates the message is missing because it is not translated in
@@ -171,7 +171,7 @@ translation file in the ``fr`` locale and run the command, you will get:
171171
---------- ------------------ ---------------------- -------------------------------
172172
State Id Message Preview (fr) Fallback Message Preview (en)
173173
---------- ------------------ ---------------------- -------------------------------
174-
fallback Symfony is great J'aime Symfony Symfony is great
174+
fallback Symfony is great Symfony is great Symfony is great
175175
---------- ------------------ ---------------------- -------------------------------
176176
177177
You can see that the translations of the message are identical in the ``fr``

0 commit comments

Comments
 (0)