Skip to content

Add docs for the WebLink component #10309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 30, 2018
Merged

Add docs for the WebLink component #10309

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6beb4eb
Add docs for the WebLink component
dunglas Sep 10, 2018
9f4ae9b
fix typo
dunglas Sep 10, 2018
178821e
refactor
dunglas Sep 10, 2018
e3d4036
RST
dunglas Sep 10, 2018
088690f
Fix link
dunglas Sep 10, 2018
e12e776
RST
dunglas Sep 10, 2018
38fda88
fix build
xabbuh Sep 11, 2018
ea7b3da
@nicolas-grekas' review
dunglas Oct 15, 2018
91ee3bc
Fix RST
dunglas Oct 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
RST
  • Loading branch information
@dunglas
dunglas committed Sep 10, 2018
commit e3d40366f861b616dee0557978a626bd586f232c
2 changes: 1 addition & 1 deletion components/weblink.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Basic usage::

.. seealso::

Read the :doc:`WebLink documentation </weblink>`_ to learn how
Read the :doc:`WebLink documentation </weblink>` to learn how
to use the features implemented by this component.

.. _`Web Links`: https://tools.ietf.org/html/rfc5988
Expand Down
8 changes: 4 additions & 4 deletions weblink.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Alternatively, you can use the `Docker installer and runtime for
Symfony`_ provided by Kévin Dunglas (community supported).

It includes everything you need to run Symfony
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure about this part + the below instruction: looks redundant with the readme of symfony-docker

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

(PHP :doc:`configured properly for Symfony </performance>`_, and Composer)
(PHP :doc:`configured properly for Symfony </performance>`, and Composer)
as well as a development reverse proxy (Apache) supporting HTTP/2 Server Push
and HTTPS (most clients only support HTTP/2 over TLS).

Expand Down Expand Up @@ -70,7 +70,7 @@ Symfony comes with a `nice integration with of the most popular CSS framework`_.
.. note::

In a real project, you should use Yarn or NPM with
:doc:`Symfony Encore </frontend/encore/bootstrap>`_
:doc:`Symfony Encore </frontend/encore/bootstrap>`
to install Bootstrap.

Now, it's time to create the template of our homepage:
Expand All @@ -93,7 +93,7 @@ Now, it's time to create the template of our homepage:
</html>

And finally, register our new template as the homepage using the builtin
:doc:`TemplateController </templating/render_without_controller>`_:
:doc:`TemplateController </templating/render_without_controller>`:

.. code-block:: yaml

Expand Down Expand Up @@ -253,7 +253,7 @@ or any service:
.. seealso::

As all Symfony components, WebLink can be used :doc:`as a
standalone PHP library </components/weblink>`_.
standalone PHP library </components/weblink>`.

To see how WebLink is used in the wild, take a look to the `Bolt`_
and `Sulu`_ CMS, they both use WebLink to trigger HTTP/2 pushes.
Expand Down