|
19 | 19 | Contributing
|
20 | 20 | ------------
|
21 | 21 |
|
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) |
25 | 24 |
|
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.2). |
30 | 27 |
|
31 |
| -SymfonyCloud |
32 |
| ------------- |
| 28 | +Build Documentation Locally |
| 29 | +--------------------------- |
33 | 30 |
|
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. |
36 | 33 |
|
37 |
| -Docker |
38 |
| ------- |
| 34 | +```bash |
| 35 | +$ git clone [email protected]:symfony/symfony-docs.git |
39 | 36 |
|
40 |
| -You can build the documentation project locally with these commands: |
| 37 | +$ cd symfony-docs/ |
| 38 | +$ cd _build/ |
41 | 39 |
|
42 |
| -```bash |
43 |
| -# build the image... |
44 |
| -$ docker build . -t symfony-docs |
| 40 | +$ composer install |
45 | 41 |
|
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 |
49 | 43 | ```
|
50 | 44 |
|
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`). |
| 45 | +Now you can browse the docs at `_build/output/index.html` |
0 commit comments