Skip to content

Commit d7a9abc

Browse files
committed
Merge branch '5.4' into 14123
2 parents 502befb + 77f2b79 commit d7a9abc

File tree

467 files changed

+16562
-15189
lines changed

Some content is hidden

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

467 files changed

+16562
-15189
lines changed

.doctor-rst.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ whitelist:
7171
- '/``.yml``/'
7272
- '/(.*)\.orm\.yml/' # currently DoctrineBundle only supports .yml
7373
- '/rst-class/'
74+
- /docker-compose\.yml/
7475
lines:
7576
- 'in config files, so the old ``app/config/config_dev.yml`` goes to'
7677
- '#. The most important config file is ``app/config/services.yml``, which now is'
@@ -88,7 +89,7 @@ whitelist:
8889
- '.. versionadded:: 1.11' # MakerBundle
8990
- '.. versionadded:: 1.3' # MakerBundle
9091
- '.. versionadded:: 1.8' # MakerBundle
91-
- '.. versionadded:: 1.6' # Flex in setup/upgrade_minor.rst
92+
- '.. versionadded:: 1.18' # Flex in setup/upgrade_minor.rst
9293
- '.. versionadded:: 1.0.0' # Encore
9394
- '0 => 123' # assertion for var_dumper - components/var_dumper.rst
9495
- '1 => "foo"' # assertion for var_dumper - components/var_dumper.rst
@@ -102,6 +103,8 @@ whitelist:
102103
- 'provides a ``loginUser()`` method to simulate logging in in your functional'
103104
- '.. code-block:: twig'
104105
- '.. versionadded:: 3.6' # MonologBundle
106+
- '// bin/console'
105107
- 'End to End Tests (E2E)'
106108
- '.. code-block:: php'
107109
- '.. _`a feature to test applications using Mercure`: https://github.com/symfony/panther#creating-isolated-browsers-to-test-apps-using-mercure-or-websocket'
110+
- '.. End to End Tests (E2E)'

.github/CODE_OF_CONDUCT.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ If your pull request fixes a BUG, use the oldest maintained branch that contains
44
the bug (see https://symfony.com/releases for the list of maintained branches).
55
66
If your pull request documents a NEW FEATURE, use the same Symfony branch where
7-
the feature was introduced (and `5.x` for features of unreleased versions).
7+
the feature was introduced (and `6.x` for features of unreleased versions).
88
99
-->

.github/workflows/ci.yaml

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,6 @@ on:
99
- 'github-comments'
1010

1111
jobs:
12-
sphinx-build:
13-
name: Build (Sphinx)
14-
15-
runs-on: ubuntu-latest
16-
17-
container: python:3.7-alpine
18-
19-
steps:
20-
- name: "Checkout"
21-
uses: actions/checkout@v2
22-
23-
- name: "Display Python version"
24-
run: python -c "import sys; print(sys.version)"
25-
26-
- name: "Install Sphinx"
27-
run: pip install --user sphinx
28-
29-
- name: "Install dependencies"
30-
run: apk add --no-cache git make
31-
32-
- name: "Install custom requirements via pip"
33-
run: pip install -r _build/.requirements.txt
34-
35-
- name: "Build documentation"
36-
run: make -C _build SPHINXOPTS="-nqW -j auto" html
37-
3812
symfony-docs-builder-build:
3913
name: Build (symfony-tools/docs-builder)
4014

@@ -49,7 +23,7 @@ jobs:
4923
- name: "Set-up PHP"
5024
uses: shivammathur/setup-php@v2
5125
with:
52-
php-version: 8.0
26+
php-version: 8.1
5327
coverage: none
5428
tools: "composer:v2"
5529

@@ -71,11 +45,7 @@ jobs:
7145

7246
- name: "Build the docs"
7347
working-directory: _build
74-
run: php build.php -vvv
75-
76-
- name: Show log file
77-
if: ${{ always() }}
78-
run: cat _build/logs.txt || true
48+
run: php build.php --disable-cache
7949

8050
doctor-rst:
8151
name: Lint (DOCtor-RST)
@@ -117,7 +87,7 @@ jobs:
11787
- name: Set-up PHP
11888
uses: shivammathur/setup-php@v2
11989
with:
120-
php-version: 8.0
90+
php-version: 8.1
12191
coverage: none
12292

12393
- name: Fetch branch from where the PR started
@@ -144,7 +114,7 @@ jobs:
144114

145115
- name: Install dependencies
146116
if: ${{ steps.find-files.outputs.files }}
147-
run: composer create-project symfony-tools/code-block-checker _checker
117+
run: composer create-project symfony-tools/code-block-checker:@dev _checker
148118

149119
- name: Install test application
150120
if: ${{ steps.find-files.outputs.files }}

.gitignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,2 @@
1-
/_build/doctrees
2-
/_build/spelling
3-
/_build/html
4-
/_build/logs.txt
51
/_build/vendor
62
/_build/output
7-
*.pyc

.symfony.cloud.yaml

Lines changed: 0 additions & 48 deletions
This file was deleted.

.symfony/routes.yaml

Lines changed: 0 additions & 11 deletions
This file was deleted.

.symfony/services.yaml

Lines changed: 0 additions & 1 deletion
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

Dockerfile

Lines changed: 0 additions & 16 deletions
This file was deleted.

README.markdown

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,33 @@
1919
Contributing
2020
------------
2121

22-
We love contributors! For more information on how you can contribute to the
23-
Symfony documentation, please read
24-
[Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html)
22+
We love contributors! For more information on how you can contribute, please read
23+
the [Symfony Docs Contributing Guide](https://symfony.com/doc/current/contributing/documentation/overview.html)
2524

26-
> **Note**
27-
> All pull requests must be based on the ``4.4`` branch,
28-
> unless you are documenting a feature that was introduced *after* Symfony 4.4
29-
> (e.g. in Symfony 5.2), **not** the ``5.x`` or older branches.
25+
**Important**: use `4.4` branch as the base of your pull requests, unless you are
26+
documenting a feature that was introduced *after* Symfony 4.4 (e.g. in Symfony 5.4).
3027

31-
SymfonyCloud
32-
------------
28+
Build Documentation Locally
29+
---------------------------
3330

34-
Thanks to [SymfonyCloud](https://symfony.com/cloud) for providing an integration
35-
server where Pull Requests are built and can be reviewed by contributors.
31+
This is not needed for contributing, but it's useful if you want to debug some
32+
issue in the docs or if you want to read Symfony Documentation offline.
3633

37-
Docker
38-
------
34+
```bash
35+
$ git clone git@github.com:symfony/symfony-docs.git
3936

40-
You can build the documentation project locally with these commands:
37+
$ cd symfony-docs/
38+
$ cd _build/
4139

42-
```bash
43-
# build the image...
44-
$ docker build . -t symfony-docs
40+
$ composer install
4541

46-
# ...and start the local web server
47-
# (if it's already in use, change the '8080' port by any other port)
48-
$ docker run --rm -p 8080:80 symfony-docs
42+
$ php build.php
43+
```
44+
45+
After generating docs, serve them with the internal PHP server:
46+
47+
```bash
48+
$ php -S localhost:8000 -t output/
4949
```
5050

51-
You can now read the docs at http://127.0.0.1:8080 (if you use a virtual
52-
machine, browse its IP instead of localhost; e.g. `http://192.168.99.100:8080`).
51+
Browse `http://localhost:8000` to read the docs.

_build/.requirements.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)