symfony-cmf/symfony-cmf-docs

Throughly review the Tutorial

wouterj opened this issue · 4 comments

  • Make sure the examples work
  • Follow the symfony best practices (see #591)
  • Do not use unmaintained components (e.g. simple cms bundle)

We should create a litte repositories for the examples, little running apps. That is a think i prefer when preparing my talks.

But i will collect some hints first:

  • Main Page - Collection has a wrong order:
    ** Getting Started
    **Routing
    ** Controllers
    ** Documents
    ** Routing Auto
    ** Backend
    ** Conclusion
  • Getting Started
    ** one or two more sentences for the initializing of the project
    ** Bundle generation still state of the art? @wouterj ping
    ** Why do we create documents - add some sentences what they are and why we need them, maby compared with ORM Entity
    ** Repository Initializer - when is it called (fixtures:load/repository:init) - add the end: just a tool for our FixtureLoadingExamples, useless for running aps
  • Routing and Automatic Routing
    **I would start with simple routing example first and then you got a reason why to use RoutingAuto
  • The Backend - Sonata Admin
    ** no mor user_sonata_admin -> sonata-admin-integration config instead
    ** maybe add a ckeditor type to the content?
    ** TreeBrowserInitializing isn't actual with 2.0
  • Controllers and Templates
    ** tbd.
  • CMS with RoutingAuto
    ** tbd.
dbu commented

i think we should get rid of the tutorial. go through it to see if there is anything important that should be added to the bundle docs, and then delete the rest.

for running code examples, lets use the sandbox. if there are interesting things in the tutorial, lets port them into the sandbox

dbu commented

we have the quick tour. imho that is enough of a tutorial.

if somebody wants to host a more complete tutorial, please do, and we can also link it from the doc, but it should not be part of the doc.

ok if we replace this issue with "remove tutorial / integrate important bits into quick tour / bundle docs"?