Skip to content

Commit 3583a4c

Browse files
noniagriconomiewouterj
authored andcommitted
[Workflow] config doc
1 parent 775f22b commit 3583a4c

File tree

256 files changed

+7802
-5256
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

256 files changed

+7802
-5256
lines changed

.github/CODEOWNERS

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Console
2+
/console* @chalasr
3+
/components/console* @chalasr
4+
5+
# Form
6+
/forms.rst @xabbuh
7+
/components/form* @xabbuh
8+
/reference/forms* @xabbuh
9+
10+
# PropertyInfo
11+
/components/property_info* @dunglas
12+
13+
# Security
14+
/security* @chalasr
15+
/components/security* @chalasr
16+
17+
# Validator
18+
/validation/*
19+
/components/validator* @xabbuh
20+
/reference/constraints* @xabbuh
21+
22+
# Workflow
23+
/workflow* @lyrixx
24+
/components/workflow* @lyrixx
25+
26+
# Yaml
27+
/components/yaml* @xabbuh

_build/_themes/_exts/symfonycom/sphinx/lexer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class TerminalLexer(RegexLexer):
1010
tokens = {
1111
'root': [
1212
('^\$', Generic.Prompt, 'bash-prompt'),
13-
('^[^\n>]+>', Generic.Prompt, 'dos-prompt'),
13+
('^>', Generic.Prompt, 'dos-prompt'),
1414
('^#.+$', Comment.Single),
1515
('^.+$', Generic.Output),
1616
],

_build/maintainer_guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ interface. Then:
9393
Merging Process
9494
~~~~~~~~~~~~~~~
9595

96-
At first it's common to make mistakes and merge things badly. Don't worry. This
96+
At first, it's common to make mistakes and merge things badly. Don't worry. This
9797
has happened to all of us and we've always been able to recover from any mistake.
9898

9999
Step 1: Select the right branch to merge
@@ -120,8 +120,8 @@ Step 2: Merge the pull request
120120
Never use GitHub's web interface (or desktop clients) to merge PRs or to solve
121121
merge conflicts. Always use the ``gh`` tool for anything related to merges.
122122

123-
We require 2 approval votes from team members before merging a PR, except if
124-
it's a typo, a small change or an obvious error.
123+
We require two approval votes from team members before merging a PR, except if
124+
it's a typo, a small change or clearly an error.
125125

126126
If a PR contains lots of commits, there's no need to ask the contributor to
127127
squash them. The ``gh`` tool does that automatically. The only exceptions are

_build/redirection_map

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -417,3 +417,15 @@
417417
/workflow/state-machines /workflow/introduction
418418
/workflow/usage /workflow
419419
/introduction/from_flat_php_to_symfony2 /introduction/from_flat_php_to_symfony
420+
/configuration/environment_variables /configuration/env_var_processors
421+
/configuration/configuration_organization /configuration
422+
/configuration/environments /configuration
423+
/configuration/configuration_organization /configuration
424+
/email/dev_environment /mailer
425+
/email/spool /mailer
426+
/email/testing /mailer
427+
/contributing/community/other /contributing/community
428+
/profiler/storage /profiler
429+
/setup/composer /setup
430+
/security/security_checker /setup
431+
/service_container/parameters /configuration
181 Bytes
Loading
Loading

_images/form/form-custom-type-postal-address-fragment-names.svg

Lines changed: 1 addition & 0 deletions
Loading

_images/form/form-custom-type-postal-address.svg

Lines changed: 1 addition & 0 deletions
Loading

_images/sources/README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
How to Create Symfony Diagrams
2+
==============================
3+
4+
Creating the Diagram
5+
--------------------
6+
7+
* Use [Dia][1] as the diagramming application;
8+
* Use [PT Sans Narrow][2] as the only font in all diagrams (if possible, use
9+
only the "normal" weight for all contents);
10+
* Use 36pt as the base font size;
11+
* Use 0.10 cm width for lines and shape borders;
12+
* Use the following color palette:
13+
* Text, lines and shape borders: black (#000000)
14+
* Shape backgrounds:
15+
* Grays: dark (#4d4d4d), medium (#b3b3b3), light (#f2f2f2)
16+
* Blue: #b2d4eb
17+
* Red: #ecbec0
18+
* Green: #b2dec7
19+
* Orange: #fddfbb
20+
21+
In case of doubt, check the existing diagrams or ask to the
22+
[Symfony Documentation Team][3].
23+
24+
Saving and Exporting the Diagram
25+
--------------------------------
26+
27+
* Save the original diagram in `*.dia` format in `_images/sources/<folder-name>`;
28+
* Export the diagram to SVG format and save it in `_images/<folder-name>`.
29+
30+
Including the Diagram in the Symfony Docs
31+
-----------------------------------------
32+
33+
Use the following snippet to embed the diagram in the docs:
34+
35+
```
36+
.. raw:: html
37+
38+
<object data="../_images/<folder-name>/<diagram-file-name>.svg" type="image/svg+xml"></object>
39+
```
40+
41+
Reasoning
42+
---------
43+
44+
* Dia was chosen because it's one of the few applications which are free, open
45+
source and compatible with Linux, macOS and Windows.
46+
* Font, colors and line widths were chosen to be similar to the diagrams used
47+
in the best tech books.
48+
49+
Troubleshooting
50+
---------------
51+
52+
* On some macOS systems, Dia cannot be executed as a regular application and
53+
you must run the following console command instead:
54+
`export DISPLAY=:0 && /Applications/Dia.app/Contents/Resources/bin/dia`
55+
56+
[1]: http://dia-installer.de/
57+
[2]: https://fonts.google.com/specimen/PT+Sans+Narrow
58+
[3]: https://symfony.com/doc/current/contributing/code/core_team.html
Binary file not shown.

0 commit comments

Comments
 (0)