A month of Symfony Documentation #6 (May 2015)

It has been an amazing month for the documentation: The Symfony 2.7 release came with lots of new features which had to be documented and there was a very active documentation hack day on May 23rd.

Documentation Hack Day

Thanks to everyone who joined us in the #symfony-docs channel on freenode to help during the doc hackday! We had a great atmosphere, got a lot of work done and had time to brainstorm ways to improve the most important areas of the docs. In total, 34 new PRs were created and 37 other PRs were closed (some were taken over by other people and many others were merged). A very big thanks to everyone joining us this day!

New Documentation

With the Symfony 3 release closing in, people started to become confused on how to prepare their code. This is why Wouter de Jong and Ryan Weaver wrote 2 small cookbook articles about Upgrading a Major Version and What do these "XXX is deprecated " E_USER_DEPRECATED Warnings mean?

Wouter also created an article explaining how to use Bower in your Symfony application. This is the first article in a new "Frontend" section of the cookbook. We hope to have more tips and tricks on how to use frontend tooling inside Symfony soon. If you have some ideas on what can be documented or if you can document something, we're happy to see the issues/pull requests!

The Framework config reference is completely restructured. It's now complete and many references and other details were added.

Nicolas Grekas has updated the VarDumper component docs with information about the VarDumperTestTrait and the new with*() methods.

Meanwhile, Christian Flothmann made sure words like "Stylesheet", "frontend" and "boolean" are spelled the same way throughout the documentation.

Proposed Documentation

Alexander M. Turek proposed documentation for the first 2.8 feature: Array denormalization. This allows you to deserialize arrays of objects.

Kévin Dunglas added documentation for the new PSR-7 brigde, allowing you to convert a PSR-7 Response/Request into a Symfony Response/Request and the other way around.

Javier Eguiluz is working hard on documenting the behaviour of prototyped arrays in the Config component and how to customize this behaviour.

How you Can Help this Month

While Symfony 2.7 is already released, not all new features are documented yet. You can find the missing features in the 2.7 milestone of the issue tracker. Besides these, you can always go through the easy pick issues to find an issue that should be easy to fix.

If you have any questions, feel free to leave a comment or ask for help in the #symfony-docs channel on Freenode.

Documentation Activity

This month, 79 pull requests were merged. A full list of changes can be found in the changelog.

The documentation is maintained by Ryan Weaver, Christian Flothmann and Wouter de Jong. Its source can be found on GitHub.

Help the Symfony project!

As with any Open-Source project, contributing code or documentation is the most common way to help, but we also have a wide range of sponsoring opportunities.

A month of Symfony Documentation #6 (May 2015) symfony.com/blog/a-month-of-symfony-documentation-6-may-2015

Tweet this


The new article about deprecation warning already needs to be updated for Symfony 2.7.1 as we changed a bit the way we trigger these warnings to make them less intrusive (making half of the article obsolete)

Comments are closed.

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