Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

[Facelift] Symfony2 and HTTP Fundamentals (book/http_fundamentals.rst) #2373

Closed
weaverryan opened this Issue · 4 comments

4 participants

@weaverryan
Collaborator

This ticket is about re-reading the "Symfony2 and HTTP Fundamentals" 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?

@kreneat

The article seems very clear and precise. I have found no issues with it.

@stof

For lazy people, the direct link to the page is http://symfony.com/doc/current/book/http_fundamentals.html

@weaverryan
Collaborator

@stof haha, thanks - I was the lazy one as I was creating these tickets in mass :)

@stof

I found a few things:

  • the note presenting the fact that the HttpFoundation component is standalone should have a link to the component documentation
  • The note This example uses YAML to define the routing configuration. Routing configuration can also be written in other formats such as XML or PHP. in "A symfony Request in action" should be removed as the example now shows all formats
  • I find it weird that the section Standalone Tools: The Symfony2 Components features the Security and Form components but not the HttpKernel one
@WouterJ WouterJ closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.