Skip to content

[Routing] do not install SensioFrameworkExtraBundle #9983

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.

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 2 commits into from
Jul 24, 2018

Conversation

Tobion
Copy link
Contributor

@Tobion Tobion commented Jun 30, 2018

The routing annotations of SensioFrameworkExtraBundle are deprecate since sensiolabs/SensioFrameworkExtraBundle#562
Also the example code in this documentation does not use SensioFrameworkExtraBundle at all but the core annotation as it should be. So installing the SensioFrameworkExtraBundle is pointless.

The routing annotations of SensioFrameworkExtraBundle are deprecate since sensiolabs/SensioFrameworkExtraBundle#562
Also the example code in this documentation does not use SensioFrameworkExtraBundle at all but the core annotation as it should be. So installing the SensioFrameworkExtraBundle is pointless.
@@ -20,12 +20,6 @@ the change is simple.
Creating Routes
---------------

First, add support for annotations via the SensioFrameworkExtraBundle:
Copy link
Contributor

Choose a reason for hiding this comment

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

This is still a requirement unless one need only routing annotation and should then depend on doctrine annotation or doctrine common as this bundle does.
We should adapt the note but we cannot remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This page is about routing. So why exactly is this still a requirement for routing?

Copy link
Contributor

Choose a reason for hiding this comment

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

Because the routing component or the basic skeleton don't rely on doctrine annotations by default.

Copy link
Member

Choose a reason for hiding this comment

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

I've reworded as requested by @HeahDude. Also, we don't use Flex shortcuts in the docs to make everything explicit, but we could make an exception in this case with composer require annotations

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm 👍 for the exception here. Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Why don't we require doctrine/annotations here instead?

Copy link
Member

@javiereguiluz javiereguiluz Jul 25, 2018

Choose a reason for hiding this comment

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

Although that be technically correct ... it's confusing for readers. We're in the routing chapter, one of the essential and critical chapters of the docs. It's already confusing to tell them to install annotations (because that basic feature should always be included and available in Symfony). If we tell them to install doctrine/annotations ... there will be a WTF moment. doctrine? What's this? And some people will think it's a doc error 😢

@HeahDude HeahDude added this to the 4.0 milestone Jul 1, 2018
fabpot added a commit to sensiolabs/SensioFrameworkExtraBundle that referenced this pull request Jul 23, 2018
This PR was squashed before being merged into the 5.2.x-dev branch (closes #577).

Discussion
----------

Update routing annotations doc as deprecated

Fixes #568 together with symfony/symfony-docs#9983

Commits
-------

b5a4237 Update routing annotations doc as deprecated
@javiereguiluz
Copy link
Member

It's merged now! thank you all for the discussion.

@javiereguiluz javiereguiluz merged commit c98babf into symfony:4.0 Jul 24, 2018
javiereguiluz added a commit that referenced this pull request Jul 24, 2018
…on, javiereguiluz)

This PR was merged into the 4.0 branch.

Discussion
----------

[Routing] do not install SensioFrameworkExtraBundle

The routing annotations of SensioFrameworkExtraBundle are deprecate since sensiolabs/SensioFrameworkExtraBundle#562
Also the example code in this documentation does not use SensioFrameworkExtraBundle at all but the core annotation as it should be. So installing the SensioFrameworkExtraBundle is pointless.

<!--

If your pull request fixes a BUG, use the oldest maintained branch that contains
the bug (see https://symfony.com/roadmap for the list of maintained branches).

If your pull request documents a NEW FEATURE, use the same Symfony branch where
the feature was introduced (and `master` for features of unreleased versions).

-->

Commits
-------

c98babf Reword
6119b67 [Routing] do not install SensioFrameworkExtraBundle
@Tobion Tobion deleted the patch-2 branch July 25, 2018 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants