Comments on: Symfony Great Except Documentation http://rogercollins.com/2010/04/symfony-great-except-documentation/ Roger Collins on Domains, Internet, Software, Society Tue, 06 Dec 2011 14:40:10 +0000 hourly 1 http://wordpress.org/?v=3.3 By: Scott http://rogercollins.com/2010/04/symfony-great-except-documentation/comment-page-1/#comment-658 Scott Fri, 13 Aug 2010 15:54:08 +0000 http://rogercollins.com/?p=362#comment-658 A consultant we had when we started sold us on symfony when it was in Version 1.0. The consultant went on to bigger and better things and i was left learning symfony from scratch. I have a love hate relationship with it for sure. Some parts are great some parts just drive me nuts. I've played with Cake PHP a little bit recently and love it. It's not as robust as symfony but it's just much easier to get from point A to B and done without having to have a PhD in computer science. The one thing that i noticed is that Cake's documention is in a WIKI style. So if they find something wrong with it they can CHANGE IT! As Jonathan Says "Keeping the documentation up-to-date and complete is probably the hardest thing to do in an open source project" I could be wrong but people find mistakes in the docs and then post the fixes for it in their own blogs which you may or may not find with your google search. If the actual docs maybe were Wiki Style more developers would contribute to the Documentation. A consultant we had when we started sold us on symfony when it was in Version 1.0. The consultant went on to bigger and better things and i was left learning symfony from scratch.

I have a love hate relationship with it for sure. Some parts are great some parts just drive me nuts.

I’ve played with Cake PHP a little bit recently and love it. It’s not as robust as symfony but it’s just much easier to get from point A to B and done without having to have a PhD in computer science.

The one thing that i noticed is that Cake’s documention is in a WIKI style. So if they find something wrong with it they can CHANGE IT!

As Jonathan Says “Keeping the documentation up-to-date and complete is probably the hardest thing to do in an open source project”

I could be wrong but people find mistakes in the docs and then post the fixes for it in their own blogs which you may or may not find with your google search.

If the actual docs maybe were Wiki Style more developers would contribute to the Documentation.

]]> By: Roger Collins http://rogercollins.com/2010/04/symfony-great-except-documentation/comment-page-1/#comment-578 Roger Collins Wed, 21 Apr 2010 16:28:09 +0000 http://rogercollins.com/?p=362#comment-578 Jonathan, Thank you for commenting. I see your point and can't really disagree about how hard documentation is to create and maintain. My bad for down playing the effort. I'd be glad to help with the documentation project. I'm a complete newbie when it comes to open source contributing though so I wouldn't try to lead the effort. Off the cuff, I'd recommend copying the process and tools that PHP is using. That doc is awesome for most pieces although I have noticed some extensions getting a little short changed on documentation even there - supporting your point about open source documentation in general. Cheers, Roger Jonathan,

Thank you for commenting. I see your point and can’t really disagree about how hard documentation is to create and maintain. My bad for down playing the effort.

I’d be glad to help with the documentation project. I’m a complete newbie when it comes to open source contributing though so I wouldn’t try to lead the effort.

Off the cuff, I’d recommend copying the process and tools that PHP is using. That doc is awesome for most pieces although I have noticed some extensions getting a little short changed on documentation even there – supporting your point about open source documentation in general.

Cheers,
Roger

]]> By: Arturo http://rogercollins.com/2010/04/symfony-great-except-documentation/comment-page-1/#comment-543 Arturo Tue, 06 Apr 2010 16:49:36 +0000 http://rogercollins.com/?p=362#comment-543 The definitive guide to symfony was a great reference for sf1.0, but I think it won't be updated for 1.3/1.4. Too bad indeed. Lets see if we get a definitive guide to sf2.0 book. BTW I love the framework too. The definitive guide to symfony was a great reference for sf1.0, but I think it won’t be updated for 1.3/1.4. Too bad indeed.

Lets see if we get a definitive guide to sf2.0 book.

BTW I love the framework too.

]]> By: Jonathan H. Wage http://rogercollins.com/2010/04/symfony-great-except-documentation/comment-page-1/#comment-540 Jonathan H. Wage Mon, 05 Apr 2010 22:13:45 +0000 http://rogercollins.com/?p=362#comment-540 I agree with you except for where you said, "is so much easier to fix than developing the framework in the first place". I really disagree. Keeping the documentation up-to-date and complete is probably the hardest thing to do in an open source project. Especially to be the ones who are writing the software AND the documentation. I think in other projects/languages the documentation has much more contributors providing help. We don't have so much right now and it is very difficult to keep things in sync as the projects move forward at a rapid pace. If it were so easy, then someone would already be doing it. Especially when we don't have anybody contributing. Maybe you can help? I agree with you except for where you said, “is so much easier to fix than developing the framework in the first place”. I really disagree. Keeping the documentation up-to-date and complete is probably the hardest thing to do in an open source project. Especially to be the ones who are writing the software AND the documentation. I think in other projects/languages the documentation has much more contributors providing help. We don’t have so much right now and it is very difficult to keep things in sync as the projects move forward at a rapid pace.

If it were so easy, then someone would already be doing it. Especially when we don’t have anybody contributing. Maybe you can help?

]]>