Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Conversation

@tiagojsag
Copy link
Contributor

'Overview' and 'Routing' parts of 'Getting started'

@lsmith77
Copy link
Member

hmm i have to go through in more detail but i think we will need a section for the routing component to link to as there are lots of people using the component without any of the rest of the CMF.

@tiagojsag
Copy link
Contributor Author

I've written it with with just Routing in mind. All references to RoutingExtra and full Symfony2/CMF integration functionalities are clearly marked as being optional and part of another bundle. Maybe just add a link from "Bundles" to this page, since none is available?

@lsmith77
Copy link
Member

well i think it makes sense to have a doc page explaining how the CMF uses the Routing component and RoutingExtraBundle/SimpleCmsBundle, however we still need to provide a doc page that is clearly defined as the documentation for the Routing component so that people that do not care about the CMF know to go there if they do care about our Routing component. this is exactly how core does it.

@lsmith77
Copy link
Member

note its ok to have some redundant information to ensure that we have a decent reading experience, but its ok to also in specific places link to other chapters because if we have a ton of redundant content it will likely get out of sync all the time.

@tiagojsag
Copy link
Contributor Author

Another possible solution is to move this "Routing" to the bundles section, since there isn't one yet, and create a new "Routing" entry for "getting started", where the routing can be explained from a user point of view, ignoring the separation between Routing and RoutingExtra and the "how it's done", just explain "What it does" and basic config with config.yml. Advanced topics would be covered in the bundles section, like in core.

@lsmith77
Copy link
Member

yeah .. or in other words .. keep the existing chapters and just add a new getting started chapter.

@tiagojsag
Copy link
Contributor Author

About the Routing chapter I commited, which replaced the old one. Shall I move it to Bundles, or use the old one?

@lsmith77
Copy link
Member

the Bundle chapter in your PR should imho remain as the component chapter. it just needs to be made more storage agnostic. ie. it currently talks about documents etc. and then we need a new chapter for the "getting started" that simply explains at a high level how the routing works. that there is a router chain, that a dynamic router uses a provider to find matching documents and uses enhancers to set defaults in those dynamic routes. and it references the routing component and routingextrabundle/simplecmsbundle docs where appropriate for those that want more details.

@tiagojsag
Copy link
Contributor Author

What should be the correct name for it? Content?
Also, what's the difference between Bundle and Component sections?

@lsmith77
Copy link
Member

i think the name is fine as you chose it, ie. getting-started/routing.rst
the difference between the two chapters is that the component is storage agnostic and also does not talk about "config.yml" etc .. really the core documentation is the guideline here.

@dbu
Copy link
Member

dbu commented Dec 10, 2012

component is something that you can use without the symfony framework if you want. like drupal is going to use the routing component but it is not using the RoutingExtraBundle because they do not use the FrameworkBundle.

to use the component "naked", the user needs to bootstrap all services himself as there is no configuration or dependency injection container available. its really about how to use the code in your non-symfony project and then how to use the code in general. RoutingExtraBundle is inside symfony, you have the configuration and DI container doing all its magic for you.

lsmith77 added a commit that referenced this pull request Dec 22, 2012
'Overview' and 'Routing' parts of 'Getting started'
@lsmith77 lsmith77 merged commit 8aa6b70 into symfony-cmf:master Dec 22, 2012
@tiagojsag tiagojsag deleted the first_steps branch January 2, 2013 10:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants