This forum is in READ-ONLY mode.
You can look around, but if you want to ask a new question, please use the new forum.
Home » development » Documentation » Developer for documentation?
Developer for documentation? [message #71816] Sun, 08 February 2009 20:56 Go to next message
pwaring  is currently offline pwaring
Messages: 2
Registered: February 2009
Junior Member
Is there are developer who specifically looks after documentation? I've filed a couple of tickets myself relating to parts of the Symfony docs in the past, but looking at the tickets marked documentation they don't seem to get closed, which kind of puts me off submitting any more:

http://trac.symfony-project.org/report/17

I know docs aren't quite as fun as actual code, but it would be great if some of the documentation tickets were looked after - especially when many of them are simple typos which can are easy fixes...


Paul Waring - Web site design and development.
Re: Developer for documentation? [message #71817 is a reply to message #71816 ] Sun, 08 February 2009 21:16 Go to previous messageGo to next message
halfer  is currently offline halfer
Messages: 9535
Registered: January 2006
Location: West Midlands, UK
Faithful Member
I am not sure, but I don't think so. You could always ask on the dev mailing list for the best course of action; you could submit patches, which might be more likely to be applied than manual fixes, or eventually you may even get svn access and apply the changes yourself.


Remember Palestine
Re: Developer for documentation? [message #80125 is a reply to message #71817 ] Thu, 18 June 2009 13:26 Go to previous messageGo to next message
Russ  is currently offline Russ
Messages: 413
Registered: August 2008
Location: Oslo, Norway
Faithful Member

There is a small group that contributes to the documentation, but mostly by means of translations and fixing grammatical errors etc.

When the changes require more of a "decision" then it seems to be no more than a few people.

As halfer suggests, submitting a patch is a great start, also change your trac entry to start with [patch] if there is one. This is much more likely to get looked at first.

I can see that one of your bug reports was fixed by Fabien a few months ago, I'll have a quick look at the other now.


*On Freenode I am rooster*
http://www.walkandclimb.co.uk/images/monkeydust.jpghttp://www.walkandclimb.co.uk/userpix/2_linux_wave_small_2.jpg
Re: Developer for documentation? [message #80290 is a reply to message #71816 ] Fri, 19 June 2009 22:49 Go to previous messageGo to next message
pwaring  is currently offline pwaring
Messages: 2
Registered: February 2009
Junior Member
Thanks, I hadn't noticed that one of the patches had been fixed recently, I don't think I got a notification email which I would have expected.

I will try and submit patches in future - the first time I submitted a documentation ticket I hadn't used Subversion much so I had no idea how to submit a patch, but now I'm far more comfortable with it. The barrier of checking out the documentation, altering it and then creating and upload a patch just to fix a spelling mistake is also a bit of a high one if it's your first bug report on a project.

Presumably for changing the Practical Symfony book I'd be looking here?

http://trac.symfony-project.org/browser/doc/branches/1.2/job eet


Paul Waring - Web site design and development.
Re: Developer for documentation? [message #80314 is a reply to message #80290 ] Sat, 20 June 2009 13:41 Go to previous message
Russ  is currently offline Russ
Messages: 413
Registered: August 2008
Location: Oslo, Norway
Faithful Member

Yes that's correct.

With documentation patches, if you are not comfortable with submitting a patch, and the changes are relatively small, just submitting the necessary snippet of Markdown or plain-text should be sufficient.

It's much easier for the team to change something in the documentation if the bug report comes with exact details and a suggested fix, either in the ticket - or in a patch which provides all the necessary info.

One more thing about patches... if your ticket starts [patch] it will get looked at pretty quickly Wink


*On Freenode I am rooster*
http://www.walkandclimb.co.uk/images/monkeydust.jpghttp://www.walkandclimb.co.uk/userpix/2_linux_wave_small_2.jpg
Previous Topic:Differences printed book and online PDF
Next Topic:symfony and Doctrine Book - spanish showing for english selection
Goto Forum:
  

powered by FUDforum - copyright ©2001-2004 FUD Forum Bulletin Board Software