Man Pages Improvement Sprint: Difference between revisions
Jump to navigation
Jump to search
⚠️AnneGhisla (talk | contribs) (coordination for the man page sprint) |
m (→Ideas) |
||
| (11 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
Benjamin Ducke proposed on [http://lists.osgeo.org/pipermail/grass-dev/2011-January/053202.html GRASS-dev ml] to have a "man page improvement day", similar to a code sprint, with the whole community dedicating perhaps a day to finding problems in man pages and fixing them. | |||
Benjamin Ducke suggested also to rephrase things that are hard to understand or elaborate on aspects that aren't explained verbosely enough. | Benjamin Ducke suggested also to rephrase things that are hard to understand or elaborate on aspects that aren't explained verbosely enough. | ||
=== Ideas === | === Ideas === | ||
* Use [http://en.wikipedia.org/wiki/Sphinx_%28search_engine%29 Sphinx] to generate HTML pages on server (http://trac.osgeo.org/grass/ticket/151) in order to have search engine and nice layout. This requires a conversion to [http://docutils.sourceforge.net/rst.html rEST] (see ticket). | |||
* Use [http://www.docbook.org DocBook] to generate HTML or PDF pages. This requires conversion to XML. Todo: fulltext search for HTML pages. | |||
* Add/cleanup examples | |||
* Add more diagrams where appropriate | |||
* Add idea here | |||
=== Who's interested === | === Who's interested === | ||
* Markus Metz | |||
* Benjamin Ducke | |||
* Dylan Beaudette | |||
* Markus Neteler | |||
* Anne Ghisla | |||
* [[User:Landa|Martin Landa]] | |||
* Milena Nowotarska | |||
* Robert Szczepanek | |||
[[Category: Development]] | |||
Latest revision as of 11:23, 20 January 2011
Benjamin Ducke proposed on GRASS-dev ml to have a "man page improvement day", similar to a code sprint, with the whole community dedicating perhaps a day to finding problems in man pages and fixing them. Benjamin Ducke suggested also to rephrase things that are hard to understand or elaborate on aspects that aren't explained verbosely enough.
Ideas
- Use Sphinx to generate HTML pages on server (http://trac.osgeo.org/grass/ticket/151) in order to have search engine and nice layout. This requires a conversion to rEST (see ticket).
- Use DocBook to generate HTML or PDF pages. This requires conversion to XML. Todo: fulltext search for HTML pages.
- Add/cleanup examples
- Add more diagrams where appropriate
- Add idea here
Who's interested
- Markus Metz
- Benjamin Ducke
- Dylan Beaudette
- Markus Neteler
- Anne Ghisla
- Martin Landa
- Milena Nowotarska
- Robert Szczepanek