Archives


Master Symfony2 fundamentals

Be trained by SensioLabs experts (2 to 6 day sessions -- French or English).
trainings.sensiolabs.com

Discover the SensioLabs Support

Access to the SensioLabs Competency Center for an exclusive and tailor-made support on Symfony
sensiolabs.com

Ryan Weaver
Symfony Docs Hack Day Needs You on March 30th
by Ryan Weaver – March 20, 2013 – 11 comments

Hi guys! It's a great time to be in the world of Symfony! Symfony 2.2 is out, Symfony 2.3 (the first LTS) is around the corner, and we're looking forward to the release of more projects that use Symfony components, like Drupal 8 and Laravel 4. So far, we have two big conferences scheduled this year, including Symfony Live Portland, whose partially-released schedule is already amazing, including topics on Laravel, security, caching, the HttpKernel and more. See you there!

Beyond all that, there's a lot of real work being done on the core code and the documentation. The first commit to the Symfony documentation was over 3 years ago, and since then, we've grown to include a full book, lots of cookbook entries, and sections for most of the individual components. Almost 500 people have contributed, including a group that helps every single day to review pull requests.

But as we grow, we want to stay aggressive and continue to improve the quality of the docs. This means ensuring that code examples are accurate and pages are easy to understand, balancing the info you need with excess technical clutter. It means adding links between topics so that if there's more to know, you can dig in. Improving the docs means making entries shorter when possible, adding missing reference details, and making sure that we're recommending the best possible solutions.

And this is where we need your help! Whether you're a seasoned-Symfony veteran, a beginner, or even if you don't think your English is very good, we'd like you to join us on March 30th for our first ever Symfony Docs Hack Day. Here are the details:

When:

March 30th from 9am Central European Time to 5pm Eastern Standard Time

Where:

We'll meet on IRC at #symfony-docs on Freenode

Who:

Hosts weaverryan and WouterJ along with you and all your friends. The Hack Day is for everyone - we need Symfony experts and newcomers. If you're newer to Symfony, you give us a fresh look at the documentation!

And if you're not comfortable with the contributing process, it's no problem: the docs are a great way to start contributing, and we're all very nice and helpful :).

Then What?

Either WouterJ or I will help make sure you have something to do! Our focus will be:

a) Creating pull requests for actionable issues on GitHub;

b) Re-reading certain core documents for accuracy, links that can be added, ease-of-understanding, consistency, and to see if entries can be broken into pieces and made shorter;

c) Add documentation for important and missing configuration options;

d) Add missing "options" and form view "variables" to the form field reference docs.

What else!

If you have any questions, thoughts or suggestions about the documentation or any of this, just drop a comment below. If you're reading this, then you're probably a Symfony user, so the docs are for you, and we like you.

Cheers!

Comments RSS

  • Carlos Granados
    #1 Carlos Granados said on the 2013/03/20 at 16:11
    Did it have to be in the middle of the Easter weekend? I´ll be out on holidays!! Good luck anyway :-)
  • Wouter De Jong
    #2 Wouter De Jong said on the 2013/03/20 at 16:11
    Some great resources to read if you're new to the contribution process:

    - http://symfony.com/doc/current/contributing/documentation/index.html
    - https://help.github.com/articles/fork-a-repo
  • Bernhard Schussek
    #3 Bernhard Schussek said on the 2013/03/20 at 23:19
    Great initiative! Unfortunately I will be on vacation too.
  • Josh Taylor
    #4 Josh Taylor said on the 2013/03/21 at 04:02
    You're going to lose a chunk of contributors to the easter long weekend - Good Friday - Monday.
  • Ryan Weaver
    #5 Ryan Weaver said on the 2013/03/21 at 14:27
    I realized we'd clash a bit with easter - but it's no problem - this won't be our last hack day on the docs! So instead of having one in the future, we'll have this one then another one later :).

    So if you can't make it - we'll miss you - but see you next time!
  • Guillermo Gutiérrez
    #6 Guillermo Gutiérrez said on the 2013/03/21 at 14:49
    I would like to help translate the docs to spanish.
  • Wouter De Jong
    #7 Wouter De Jong said on the 2013/03/21 at 15:52
    Guillermo Gutiérrez, there is already a spanisch translation: https://github.com/gitnacho/symfony-docs-es But I'm sure the will like it if you help them!
  • Josh Taylor
    #8 Josh Taylor said on the 2013/03/22 at 09:50
    Not to say I don't think this is great - I'll be coming along to learn how to help out more on the docs.
  • marcelo prizmic
    #9 marcelo prizmic said on the 2013/03/22 at 15:52
    I think would be usefull have more documentation about forms. A recopilation of examples that explains how to resolve technical SF2 page types of data input used in web applications. remains the most difficult issue presented me. (sorry about google english translation, is not very good)
  • car dvd player buyer
    #10 car dvd player buyer said on the 2013/03/25 at 09:11
    it truly is easy to assessment advantages for International positioning method solutions or products details, that contain <a href=http://www.dvdplayer.com.cn>car dvd player headrest
    </a> Direction-finding prospect consideration coupled with evaluation journals, as well as connect to the world wide web websites and take a look at their things boasting
  • Piotr Gołębiewski
    #11 Piotr Gołębiewski said on the 2013/03/30 at 00:15
    so unfortunate i had no time to contribute (easter preperations), i hope to help next time =)