Documentation improvement

Date	2014-01-10	Contacts	François Prunayre
Status	On going	Release	3.0.1
Resources	François, Jean Pommier, Etienne Taffoureau	Ticket #
Source code
Funding	BRGM

Overview

The goals of this proposal on the documentation are:

• better access to the documentation from the application
• update the doc to the new user interface
• clean out-of-date information
• add link to github to easily update a documentation page

Languages:

• user guide at least in English and French
• dev guide in english only on github

Documentation access:

• online website
• from the application

Proposal

• Start a new documentation from scratch (drop the old one)
• Create a dedicated repository on github with a documenter team (which will be a submodule in core-geonetwork) in order to have a simple repository to make contribution easy
• Table of content (see demo web site http://docs.titellus.net/geonetwork/en/)
• All page in the documentation contains a link to the corresponding page in the github repository
• Use rst format
• Build the documentation using sphinx and maven (no need for make as we do now)

Proposal Type

• Type: Documentation
• Module: docs

Voting History

• Vote Proposed: TBA

Participants

• Etienne Taffoureau
• Francois Prunayre