One advantage to putting todos into the actual documents themselves is that they provide content to an other wise blank section. I think seeing a section that says "Todo: Getting Started section needs expanding" or similar looks better to me than just a void. Perhaps it's like those pages that say "This page intentionally left blank", although without the irony.
So I still think in general that doc tasks should go in JIRA for things "going forward", but I think that until we fill out all sections of the docs as they stand now, it could be nice to have todos. I don't feel tremendously strongly about this, but I thought it could be helpful both from a user's perspective, and also to lower the bar for contributors. Thanks, Mike Pumphrey OpenGeo - http://opengeo.org Justin Deoliveira wrote: > While I personally do want to see more doc tasks ending up in jira I > thin a lot of the stuff that would end up in a todo list would be > smaller scale... and since one usually comes up with todo items while > they are editing a document nice and handy, rather then have to go out > to jira, set up a new issue, etc... > > My 2c. > > -Justin > > Gabriel Roldan wrote: >> wonder if the todo list itself couldn't be a Jira with subtasks? >> >> Mike Pumphrey wrote: >>> Hi there. Now that some work is starting to happen on the GeoServer >>> 2.0 documentation, I propose to add a todolist document to our >>> GeoServer manuals. This will be a listing of all of the pages or >>> sections whose content isn't completed. So, adding the following >>> content to, say, the Getting Started section: >>> >>> .. todo:: Entire Getting Started section >>> >>> will generate content on the todolist page that says: >>> >>> --- >>> Todo: Entire Getting Started section >>> >>> (The original entry is located in gettingstarted\index.rst, line 6 >>> and can be found _here_.) >>> --- >>> >>> The advantage of this is so that anyone can see at a glance what work >>> still needs to be done. This could hopefully make it easier for >>> people who wish to contribute by having a handy list of where to >>> start. We can make it as granular as we want. >>> >>> If everyone says that this is a good idea, I'll make a JIRA and set >>> this up in a jiffy (starting with trunk). My only question is >>> whether we make this todolist page part of the main toctree, or >>> whether we hide it. >>> >>> >>> Thanks, >>> Mike Pumphrey >>> OpenGeo - http://opengeo.org >>> >>> ------------------------------------------------------------------------------ >>> >>> >>> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 >>> 30-Day trial. Simplify your report design, integration and deployment >>> - and focus on what you do best, core application coding. Discover >>> what's new with Crystal Reports now. http://p.sf.net/sfu/bobj-july >>> _______________________________________________ >>> Geoserver-devel mailing list >>> [email protected] >>> https://lists.sourceforge.net/lists/listinfo/geoserver-devel >> >> >> ------------------------------------------------------------------------------ >> >> >> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 >> 30-Day trial. Simplify your report design, integration and deployment >> - and focus on what you do best, core application coding. Discover >> what's new with Crystal Reports now. http://p.sf.net/sfu/bobj-july >> _______________________________________________ >> Geoserver-devel mailing list >> [email protected] >> https://lists.sourceforge.net/lists/listinfo/geoserver-devel > > ------------------------------------------------------------------------------ Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day trial. Simplify your report design, integration and deployment - and focus on what you do best, core application coding. Discover what's new with Crystal Reports now. http://p.sf.net/sfu/bobj-july _______________________________________________ Geoserver-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geoserver-devel
