[Facelift] Installing and Configuring Symfony (book/installation.rst) #2375

Closed
weaverryan opened this Issue Mar 30, 2013 · 1 comment

Projects

None yet

2 participants

@weaverryan
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?

This was referenced Mar 30, 2013
@wouterj
Symfony member

I tolk to a beginner on the IRC this afternoon and he gave us some usefull feedback. In general, we need more information about Composer.

At first, it looks like composer is optional. But at step 2, where you need to update your vendors, composer is required. That confuses people.
In fact, we tell 3 times how to install composer in that document. It will be better to explain that once and link to the composer download docs, because it also includes some usefull Windows installers.

@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