A month of Symfony Documentation #7 (June 2015)

Docs IRC Meeting

On June 25th, the docs team (WouterJ, xabbuh, weaverryan) and a few others met on Freenode #symfony-docs for our first ever meeting. The goal of these is pretty simple: improve our process to get contributions merged faster, find ways to innovate (e.g. auto-deploying pull requests) and form plans for future big stuff.

In this meeting, we streamlined the voting process to get docs merged, planned an auto-deployment of pull requests (very exciting - stay tuned), and planned to link to more third-party bundles/libraries from within the docs.

Check out the full summary. Have something to suggest about how Symfony documentation works? Join us on July 25th at 11am EST US time.

New Documentation

One of the best features of Symfony 2.6 is the new AbstractVoter, which is now finally documented. This means the How to Use Voters to Check User Permissions is now way easier thanks to Inoryy and javiereguiluz.

Speaking of 2.6, did you know that you can use relative dates with many of the built-in constraints?

1
2
3
4
5
6
7
8
9
10
11
12

// src/Acme/OrderBundle/Entity/Order.php
namespace Acme\OrderBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Order
{
    /**
     * @Assert\GreaterThan("+3 days")
     */
     protected $deliveryDate;
}

Thanks again to javiereguiluz, this ability is now documented for the GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual and Range constraints.

Symfony 2.7 came with massive improvements to the Serializer component and dunglas (author of much of that work) has done great work updating the Serializer component and Serializer cookbook documentation for these updates.

dunglas was also busy adding the documentation for the new PSR7 Bridge library that was introduced last month.

Phew! And there's even more new stuff, including an article on installing beta/unstable versions of Symfony, doing SCSS and JS processing with pure PHP libraries and a totally cleaned up and revamped File upload cookbook. For the rest, check out the CHANGELOG.

How you Can Help this Month

We have over 100 issues with the Actionable label, which means these are just in need of a volunteer to help write some docs! Don't worry if your English isn't perfect or you haven't contributed before: we'll help you out along the way.

For details, check out or Contributing to the Documentation page.

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, 55 pull requests were merged. A full list of changes can be found in the changelog.

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