Skip to content
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

Added description on how to enable the security:check command through… #5363

Merged
merged 6 commits into from
Nov 5, 2015
Merged

Added description on how to enable the security:check command through… #5363

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
396302b
Added description on how to enable the security:check command through…
bizmate Jun 6, 2015
5aa7044
Improved security:check command description
bizmate Jun 7, 2015
aa0dff4
Indented code block in security:check command description
bizmate Jun 7, 2015
5c872f2
Bundle name case change
bizmate Jun 10, 2015
8f00174
Merge remote-tracking branch 'remotes/upstream/2.7' into 2.7
bizmate Oct 18, 2015
f5774d2
Changed 'in' to 'to' and removed 'composer'
bizmate Oct 18, 2015
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
10 changes: 10 additions & 0 deletions book/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1378,6 +1378,15 @@ FriendsOfPHP organization.
any of your dependencies is affected by a known security vulnerability.
Therefore, you can easily integrate it in your build process.

.. note::

To enable the ``security:check`` command, you need to add the
`SensioDistributionBundle`_ to your dependencies.
Copy link
Member

Choose a reason for hiding this comment

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

I would end this sentence with a colon.

Copy link
Member

Choose a reason for hiding this comment

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

I liked Wouter's wording better:

To enable the ``security:check`` command, make sure the
`SensioDistributionBundle`_ is installed:


.. code-block:: bash

$ composer require 'sensio/distribution-bundle'
Copy link
Member

Choose a reason for hiding this comment

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

The single quotes are not necessary.


Final Words
-----------

Expand Down Expand Up @@ -1408,3 +1417,4 @@ Learn More from the Cookbook
.. _`frameworkextrabundle documentation`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html
.. _`security advisories database`: https://github.com/FriendsOfPHP/security-advisories
.. _`HWIOAuthBundle`: https://github.com/hwi/HWIOAuthBundle
.. _`SensioDistributionBundle`: https://packagist.org/packages/sensio/distribution-bundle
Copy link
Member

Choose a reason for hiding this comment

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

imho this should refer to the bundle's GitHub repository

Copy link
Member

Choose a reason for hiding this comment

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

I think we should link to the bundle's docs instead.