[Facelift] Creating Pages in Symfony2 (book/page_creation.rst) #2376

weaverryan opened this Issue Mar 30, 2013 · 1 comment

3 participants

Symfony member

This ticket is about re-reading this document and giving it a facelift. No matter who you are, you have a role to play in this.

How this works:

If you read this document and find some changes, you can either comment here or (even better) create a pull request. After various people have reviewed this chapter, we'll close this issue.

What to do

Well, that depends on who you are :)

If you're newer to Symfony

Read the entry and code along with it.
a) Are there inaccuracies - code that doesn't work?
b) Are there parts that just don't understand very well?
c) Are there details that aren't explained enough?
d) Is there language that's confusing?
e) Did you fall asleep while reading it? If so, good morning! Why was it so boring?
f) Are there inconsistencies between sections?

If you know Symfony pretty darn well (or want a challenge)!

a) Are there inconsistencies between sections?
b) Do you spot anything that can be done better?
c) Are we following best practices?
d) Are there sections that are too advanced or details that should be moved into a new section to keep this readable?
e) Should some details here belong somewhere else? Like in the component documentation?
f) Are there places where we can link to other areas in the documentation to help the learner cross reference?


It's been a long time since I went through the "Hello World" portion of this documentation but I remember it being a little awkward since I was working off the symfony/framework-standard-edition distribution and the included Acme/DemoBundle already has a hello world route included. It was a little confusing for me that the route already worked out of the box until I explored the demo bundle.

Also when you generate a new bundle you get the /hello/{name} route by default. While eventually this can be helpful, for someone trying to learn this can be a bit of a disservice as it is not necessary to manually create the route definition to re-enforce the concept.

@wouterj wouterj closed this Dec 23, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment