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 2 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 @@ -1352,6 +1352,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
`sensio distribution bundle`_ in your composer 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 prefer SensioDistributionBundle.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

While in the context of code I would agree, I see no need in plain documentation where links are all formatted in spaced lower cases format. Unless all other links are changed to follow the CamelCase style.

Copy link
Member

Choose a reason for hiding this comment

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

It's not because it is the link label, but because of what is the name of the bundle.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you see other links with references to bundles the formatting is not CamelCase. See line 1391 for the frameworkextrabundle

Copy link
Member

Choose a reason for hiding this comment

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

FrameworkExtraBundle is not maintained by us. In the core docs, we always use the bundle names as they are in the code: FrameworkBundle, AsseticBundle, MonologBundle, SensioFrameworkExtraBundle, etc. See http://symfony.com/doc/current/cookbook/serializer.html for instance.

Copy link
Member

Choose a reason for hiding this comment

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

And by the way, it's only lowercased in the reference mapping at the bottom. In the text, it is written as "FrameworkExtraBundle documentation" (see http://symfony.com/doc/current/book/security.html#securing-controllers-and-other-code).


.. 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.

you forgot to indent the code block (the above 3 lines should have 4 extra spaces on the left, so they align with the body of the note)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you know if there is a preview tool i can use for this documentation? I am checking on http://rst.ninjs.org/ at the moment and it displays ok but not as precise as I d like


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

Expand Down Expand Up @@ -1381,3 +1390,4 @@ Learn More from the Cookbook
.. _`online tool`: https://www.dailycred.com/blog/12/bcrypt-calculator
.. _`frameworkextrabundle documentation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html
.. _`security advisories database`: https://github.com/FriendsOfPHP/security-advisories
.. _`sensio distribution bundle`: https://packagist.org/packages/sensio/distribution-bundle