Learning about the Symfony Components

If you visited us at Symfony Day Cologne or keep a close ear on the conversation around Symfony, then you already know that momentum and awareness is rapidly growing behind the components that make up Symfony. Sure, Symfony is a framework, but more fundamentally, it's a group of 20+ decoupled components, each of which can be used inside any PHP project (yes, even that old legacy app you maintain that just won't go away).

This flexibility is what makes things like Silex possible - a microframework built using several Symfony2 components. Drupal has also decided to adopt at least two of the Symfony components for Drupal 8 and feedback from their community has already been wonderful. The beauty is that this is exactly why the components where built: to be the basic building blocks of any PHP application or framework. The fact that they're also bringing different communities together is a great bonus.

But now we need your help! As a community, we've put a lot of work into the Symfony2 framework documentation. It's not perfect, but there's a lot of great resources. Now it's time to focus on documentation for the individual components.

Fabien already kicked things off by bootstrapping a new "components" section of the documentation. But there's a lot more to do! If you'd like to learn more about the Symfony2 components and give back at the same time, here's what you can do:

  • Check out the components tag on the symfony-docs GitHub repository for a current list of pending items

  • Choose a particular component, study its files, and bootstrap its docs! Follow the example of the other sections and get us started!

  • Read the existing component documentation, try things out, and let us know how we can make things better.

The goal, of course, is for a developer to be able to install, setup, and use each component in a meaningful way just by reading through some friendly docs. Sure, we've got a ways to go, but with your help, we can get there soon!

And if you're still reading (nice work!), remember that each time you can't find documentation or read an error message that's just not clear enough, there are hundreds others just like you. But when you add those docs or improve that error message, you stop the cycle and save countless hours. That's the beauty of a community like ours. Thanks.

Comments

These are great news! I'll be following this closely.

Also a note about contributing. Because this is all on GitHub it is super easy to help out if you find a gap. Just click the "Fork and edit this file" button, type in your change and then hit the save button. Getting a Sensio Connect badge has never been easier. ;)
My opinion is to group the "Components" section in the docs by each component title, so the "The ClassLoader Component" wraps ClassLoader related docs (Like cookbook)
I am trying to explain them via examples in this github project,
https://github.com/loalf/Sf2ComponentsPlayground
@Mohamed - I think we will likely follow your advice here, at least for many of the sections. Some components are really small, so they may only need one article, while others (e.g. forms) will definitely need to be organized into its own section.
Didn't even know about the "Process" component, I do a lot of proc_opens and this looks like it will clean up a lot of code. Very nice!

Is there anything for forking processes?

Comments are closed.

To ensure that comments stay relevant, they are closed for old posts.