Bootstrap Config component documentation

[weaverryan]

Recommended sections:

• Introduction
• Installation
• Usage

[cordoval]

This is mine, ok?

[vicb]

@cordoval great ! Tere are a few issues to be taken into account: #1098, #469, #466. You should make sure there is no duplicated effort by talking with @matthiasnoback.

[cordoval]

@matthiasnoback ping what is the status of your effort, I am about to PR to change this component to support another branch, but need first to really get up to speed with all possible use cases for this. please let me know

[cordoval]

i am wanting to merge on this branch for Config the changes done by @everzet 's branch ResourceWatcher, can someone rebase and cherry pick those at least? I need to have Config updated. @stof please let me know if those changes can be merged on Config so that perhaps we can keep in mind the enhancements when preparing this documnetation.

[matthiasnoback]

@cordoval good work, I had not come as far as describing the different kinds of nodes - your pull request is much more complete - so go ahead!

[stof]

@cordoval I don't understand what you mean.

[cordoval]

nevermind @stof I will work more on the PR

[matthiasnoback]

@cordoval Now that I take a look at the documentation you've added so far, I see it's mainly a copy-paste from my blog (http://php-and-symfony.matthiasnoback.nl/2011/11/symfony2-define-your-bundles-configuration-values-using-the-treebuilder/). I am not very happy about that - in the first place I miss the credits for it, but it's also not "documentation" material (the style is quite "loose"). Do you intend to modify it and make if fit in better with the other component documentation?

[matthiasnoback]

@cordoval I just read your comment on my blog. I must admit I am not sure if I will be able to find the time to further shape the Config component's documentation, so if in the meantime anybody else is planning to work on it, this won't interfere.

[weaverryan]

I'm just catching up on this issue right now.

Currently PR #1184 is open by @cordoval to bootstrap the configuration documentation - but this is basically a copy of your blog @matthiasnoback? If so, that's not ok :/.

There are plenty of instances where people have written really nice blog posts, and then decided to also add those to the official documentation. But, that's always done by the blog author, which means that the original author is being credited for committing that topic, even if we don't actually display authorship anywhere (we try to keep everything very independent - a community effort).

So I think we need to close #1184 and either allow someone else to bootstrap the Config documentation or allow @matthiasnoback to add his own blog to the docs - which is definitely not expected - that is your work :).

@cordoval I know you didn't mean anything bad by this - you're just trying to push things forward - but I just want to be very sensitive to other people's work :).

@cordoval @matthiasnoback What do you guys want to do?

[cordoval]

correct ryan, i have no problems closing this. Apologize to matthias,
if anything. Will think harder and twice next time.

This was never a complete PR and it meant only to be a WIP i never had
time to finish/work on it as I got stuck in the code and could not put
it to use in a stand alone way.

Do you have pointers to get started on this from scratch?

You rock, I don't but i will try again man. thanks

On Sat, Apr 28, 2012 at 12:43 PM, Ryan Weaver
[email protected]
wrote:

I'm just catching up on this issue right now.

Currently PR #1184 is open by @cordoval to bootstrap the configuration documentation - but this is basically a copy of your blog @matthiasnoback? If so, that's not ok :/.

There are plenty of instances where people have written really nice blog posts, and then decided to also add those to the official documentation. But, that's always done by the blog author, which means that the original author is being credited for committing that topic, even if we don't actually display authorship anywhere (we try to keep everything very independent - a community effort).

So I think we need to close #1184 and either allow someone else to bootstrap the Config documentation or allow @matthiasnoback to add his own blog to the docs - which is definitely not expected - that is your work :).

@cordoval I know you didn't mean anything bad by this - you're just trying to push things forward - but I just want to be very sensitive to other people's work :).

@cordoval @matthiasnoback What do you guys want to do?

---

Reply to this email directly or view it on GitHub:
#962 (comment)

[keymaster]

@weaverryan @matthiasnoback @cordoval - it looks like matthiasnoback has given consent (at least that is how I read his comment above):

" I just read your comment on my blog. I must admit I am not sure if I will be able to find the time to further shape the Config component's documentation, so if in the meantime anybody else is planning to work on it, this won't interfere. "

@matthiasnoback can you please confirm?

[matthiasnoback]

No hard feelings :) it's just that copy and paste is not enough in this case. It needs to be rewritten. I have some time during the next few weeks and am willing to provide a first version of the component's documentation. Unless someone else is already on it of course.

[stof]

@weaverryan I'm giving a presentation on Config\Definition next week. I will try to find some time to turn it into some doc after it (or at least give my slides as a starting point if I don't have time)

[weaverryan]

Sounds good! @stof, we'll see if you'' have something next week, and if not, then we'll open it back up. Also, the first step here doesn't need to be big - if we get it started, then things will roll much easier from there.

Thanks everyone!

[matthiasnoback]

At the moment I do not have the Internet connection to properly set up a local Git repository for the Symfony2 documentation (I'm on vacation)... Still, I've written something on my blog, which can be reused later as the first part of the Config Component's documentation. Please take a look at http://php-and-symfony.matthiasnoback.nl/2012/05/symfony2-config-component-using-filelocator-loaders-and-loaderresolver/ and let me know what you think.

[stof]

This could be a good starting point for the Loader part of the component.

[matthiasnoback]

Again on my blog, part 2 about Definition (including TreeBuilder & ExprBuilder) and Processor: http://php-and-symfony.matthiasnoback.nl/2012/05/symfony2-config-component-config-definition-and-processing/

I've written it in a style that is general enough for the offical documentation of the Config Component.

I think this covers all parts of the Config component.

Feedback is very welcome!

[cordoval]

you rock man!

[wouterj]

I think this can be closed because #1550 is merged in?

[weaverryan]

Closed!