Hi guys!
Ah, spring - a time of flowers, sunshine and hanging out with your open source friends online! Yep, I'm talking about this year's first documentation hack day on Saturday May 23rd.
It's been a really busy year so far - Wouter began posting monthly Documentation blog updates and January was a record-breaking month for the total number of pull requests merged.
But the number of issues and unfinished pull-requests has been creeping up, and we're putting an ever-greater emphasis on making sure that all our docs are up to date, relevant and easy to understand.
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 May 23rd for our Symfony Docs Hack Day. Here are the details:
When:
May 23rd from 9am Central European Time to 3pm Eastern Standard Time
Where:
We'll meet on IRC at #symfony-docs on Freenode
Who:
Hosts weaverryan, WouterJ and xabbuh 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?
One of us will help make sure you have something to do! Our focus will be:
a) Creating pull requests for actionable issues on GitHub;
b) Adopting existing pull requests where the original contributor is too busy (it happens, no worries);
c) 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;
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!
Awesome! I don't know if I will make it, but will try to be there. I'm really curious of the opinions of others regarding the docs, compared to people who wrote it or those who have worked with it for a few years now.
@Lynn Yea, I completely agree. I do hear from a lot of people (because I meet a lot of people and ask) and they range from loving the docs (because they're complete) to not being able to figure them out (because information isn't organized well).