Skip to content

Commit dc173b6

Browse files
committed
Merge branch '2.7' into 2.8
* 2.7: Document Platform.sh on the contributing section. Mention Platform.sh on README. Better Sphinx version. Improve configuration files. Prepare Platform.sh configuration files.
2 parents 7c967ed + c63e52e commit dc173b6

File tree

6 files changed

+99
-0
lines changed

6 files changed

+99
-0
lines changed

.platform.app.yaml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# This file describes an application. You can have multiple applications
2+
# in the same project.
3+
4+
# The name of this app. Must be unique within a project.
5+
name: symfonydocs
6+
7+
# The toolstack used to build the application.
8+
type: "php"
9+
10+
build:
11+
flavor: "composer"
12+
13+
# The configuration of app when it is exposed to the web.
14+
web:
15+
# The public directory of the app, relative to its root.
16+
document_root: "/_build/html"
17+
index_files:
18+
- index.html
19+
whitelist:
20+
- \.html$
21+
- \.txt$
22+
23+
# CSS and Javascript.
24+
- \.css$
25+
- \.js$
26+
- \.hbs$
27+
28+
# image/* types.
29+
- \.gif$
30+
- \.png$
31+
- \.ico$
32+
- \.svgz?$
33+
34+
# fonts types.
35+
- \.ttf$
36+
- \.eot$
37+
- \.woff$
38+
- \.otf$
39+
40+
# robots.txt.
41+
- /robots\.txt$
42+
43+
# The size of the persistent disk of the application (in MB).
44+
disk: 512
45+
46+
# Build time dependencies.
47+
dependencies:
48+
python:
49+
sphinx: ">=1"
50+
51+
# The hooks that will be performed when the package is deployed.
52+
hooks:
53+
build: |
54+
pip install git+https://github.com/fabpot/sphinx-php.git
55+
make html

.platform/routes.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
http://www.{default}/:
2+
to: http://{default}/
3+
type: redirect
4+
http://{default}/:
5+
cache:
6+
cookies:
7+
- '*'
8+
default_ttl: 0
9+
enabled: true
10+
headers:
11+
- Accept
12+
- Accept-Language
13+
ssi:
14+
enabled: false
15+
type: upstream
16+
upstream: symfonydocs:php

.platform/services.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Keeping this file empty to not deploy unused services.

README.markdown

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,8 @@ Contributing
1414
We love contributors! For more information on how you can contribute to the
1515
Symfony documentation, please read
1616
[Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html)
17+
18+
Platform.sh
19+
-----------
20+
21+
Pull requests are automatically built by [Platform.sh](https://platform.sh).

contributing/documentation/overview.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,27 @@ steps to contribute to the Symfony documentation, which you can use as a
248248
249249
You guessed right: after all this hard work, it's **time to celebrate again!**
250250

251+
252+
Review your changes
253+
-------------------
254+
255+
Every GitHub Pull Request is automatically built and deployed by `Platform.sh`_
256+
on a single environment that you can access on your browser to review your
257+
changes.
258+
259+
.. image:: /images/contributing/docs-pull-request-platformsh.png
260+
:align: center
261+
:alt: Platform.sh Pull Request Deployment
262+
263+
To access the `Platform.sh`_ environment URL, simply go to your Pull Request
264+
page on GitHub and click on ``Details``.
265+
266+
.. note::
267+
268+
The specific configuration files at the root of the Git repository:
269+
``.platform.app.yaml``, ``.platform/services.yaml`` and
270+
``.platform/routes.yaml`` allow `Platform.sh`_ to build Pull Requests.
271+
251272
Minor Changes (e.g. Typos)
252273
--------------------------
253274

@@ -324,3 +345,4 @@ definitely don't want you to waste your time!
324345
.. _SensioLabsConnect: https://connect.sensiolabs.com/
325346
.. _`Symfony Documentation Badge`: https://connect.sensiolabs.com/badge/36/symfony-documentation-contributor
326347
.. _`sync your fork`: https://help.github.com/articles/syncing-a-fork
348+
.. _`Platform.sh`: https://platform.sh
Loading

0 commit comments

Comments
 (0)