updated configuration reference #1303

Merged
merged 2 commits into from Jun 1, 2012

Projects

None yet

3 participants

@kbond
Contributor
kbond commented Apr 23, 2012

Note that I haven't update the xml reference. I'm not sure what we should do about that. It has fallen way behind...

@weaverryan weaverryan and 1 other commented on an outdated diff Apr 28, 2012
reference/configuration/security.rst
- csrf_parameter: _csrf_token
- intention: authenticate
- csrf_provider: my.csrf_provider.id
- post_only: true
- remember_me: false
- remember_me:
- token_provider: name
- key: someS3cretKey
- name: NameOfTheCookie
- lifetime: 3600 # in seconds
- path: /foo
- domain: somedomain.foo
- secure: true
- httponly: true
- always_remember_me: false
- remember_me_parameter: _remember_me
@weaverryan
weaverryan Apr 28, 2012 Member

Hey Kevin!

What do you think about the factories? These all seem to be missing now - possible that it's because of the new way of loading this configuration?

Let me know - and thanks!

@kbond
kbond Apr 30, 2012 Contributor

Yeah, it just shows the prototype (below) - I could just copy and paste the above for now and do a PR for Symfony with a setExample that shows all the factories

@weaverryan
weaverryan May 20, 2012 Member

Hmm, yea, practically for the docs, I think we should print out all of the "core" factories here.

@stof stof and 1 other commented on an outdated diff Apr 29, 2012
reference/configuration/monolog.rst
main:
- type: fingers_crossed
+ type: fingerscrossed
@stof
stof Apr 29, 2012 Member

This is wrong. fingers_crossed is the valid type whereas fingerscrossed will fail

@kbond
Contributor
kbond commented May 14, 2012

I haven't forgotten about this - will work on updating this week.

@weaverryan weaverryan commented on the diff May 20, 2012
reference/configuration/web_profiler.rst
- # display the web debug toolbar at the bottom of pages with a summary of profiler info
- toolbar: false
@weaverryan
weaverryan May 20, 2012 Member

I'm going to want to keep these type of manually-added comments. So either you should keep them, or I'll add them back :). I realize that this can't be done automatically, and I think that's ok - we shouldn't need to do a wholesale re-export like this very often.

@weaverryan weaverryan commented on an outdated diff May 20, 2012
reference/configuration/swiftmailer.rst
+ logging: true
@weaverryan
weaverryan May 20, 2012 Member

This is a tough one, it's technically still %kernel.debug% - but the Configuration parser could never know that, since the "debug" value is just passed in as a boolean value and then used.

@weaverryan weaverryan commented on an outdated diff May 20, 2012
reference/configuration/doctrine.rst
connections:
- default:
- dbname: database
+
+ # Prototype
@weaverryan
weaverryan May 20, 2012 Member

Same thing here with the prototypes, I'm not sure this is the best way to show this (though it is the most technically correct). I think it'd make more sense to show an example usage with a note. What do you think?

@weaverryan
Member

Thanks Kevin! Sorry for the slow attention initially on this, but I'm definitely keen to get it merged in now. I want to make sure we don't lose old comments and overall want to "change" things as little as possible (e.g. keep the full security factories instead of the prototype).

See you in a few days!

@kbond
Contributor
kbond commented May 28, 2012

let me know how this looks, tried to keep the original comments.

@weaverryan weaverryan added a commit that referenced this pull request Jun 1, 2012
@weaverryan weaverryan Fixing default values that are actually %kernel.debug% but can't be a…
…uto-generated correctly - see #1303
4379241
@weaverryan weaverryan added a commit that referenced this pull request Jun 1, 2012
@weaverryan weaverryan Trying to make some of the reference "prototype" a bit more clear, th…
…ough I think that most of them are still quite obtuse and will need more research and explanation - see #1303
0504675
@weaverryan weaverryan added a commit that referenced this pull request Jun 1, 2012
@weaverryan weaverryan Changing a few of the provider keys back to what they were before to …
…be more descriptive

See #1303
354350e
@weaverryan weaverryan merged commit 505a694 into symfony:master Jun 1, 2012
@weaverryan
Member

Hey guys!

I've just merged this in - thanks @kbond for your excellent work on this.

I did make several commits tweaking small things. The biggest tweak was with the prototypes, which I think are quite confusing and, by their very nature, difficult for the generator to describe. I tried to clarify on these quickly, but I think that we still have many prototypes that are either wrong or at least a bit misleading in how they look.

So, this is a big step forward, but I think the reference stuff still needs a nice human touch at some point to play with and clarify on some options. Ideally, some of that can get back into the actual code base's info tags :).

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment