-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
mention CMF ChainRouter, restructure documentation for extending routing #6020
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
Conversation
dbu
commented
Dec 16, 2015
Q | A |
---|---|
Doc fix? | no |
New docs? | yes |
Applies to | 2.3+ |
Fixed tickets | Relates to #5709 |
redirect_trailing_slash | ||
extra_information | ||
extending_routing | ||
custom_route_loader | ||
multiple_routers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure if its ok to add multiple levels of navigation here, but i think it would make sense. also not sure if this is the right syntax for rst.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't work in the table of contents. You will probably want to update /cookbook/routing/map.rst.inc
instead. But I am not sure if the symfony.com theme is able to render that properly (the platform.sh preview will tell us though).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is no /cookbook/routing/map.rst.inc file i think. do you have an idea how we should do this? or should we give up on making this a sub-group and just cram it into one article? or a series that repeat part of the title: "Extending Routing: ..."?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh sorry about that. :( The right file is /cookbook/map.rst.inc
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
The Symfony CMF ChainRouter allows to use more than one router. A main | ||
use case is to keep the :doc:`default symfony routing system </book/routing>` | ||
available when writing a custom controller. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
custom router?
While I think it's good to write a short section about this, we have to make sure to not duplicate much from the CMF docs. The CMF Routing docs already suffer a lot from duplication (bundles, components & quick tour). Adding yet another one would make things hard to maintain. |
agreed that we should not duplicate this here. the idea is to really just showcase what dynamic router does and then link to the cmf documentation. |
any input on where to put the new sections in the navigation? should i put extending_routing, custom_route_loader and multiple_routers all into one page? or just list the 3 on one level? or add another level or hierarchy? |
ping @weaverryan |
This PR was merged into the 2.3 branch. Discussion ---------- mention routing from the database | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.3+ | Fixed tickets | #2186, relates to #5709 if we merge #6020, we might want to put this as subsection of the extending_routing section Commits ------- c458431 mention routing from the database
I think "extending routing" and "custom route loader" could share one document while "multiple routers" better fits in its own article. |
process, e.g. JmsI18nRoutingBundle_. | ||
|
||
.. _FrameworkExtraBundle: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html | ||
.. _JMSI18nRoutingBundle: https://github.com/schmittjoh/JMSI18nRoutingBundle |
There was a problem hiding this comment.
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 here: http://jmsyst.com/bundles/JMSI18nRoutingBundle - the GitHub page just points you there.
Sorry for the delay @dbu! I think we should:
Overall, I really feel that having a lot of top-level "How do I do X" is useful. Cheers! |
I'm closing this as "fixed" because:
|