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:

• define how to provide access to the documentation from the application
• define the documentation table of content to be updated and populated based on the GeoNetwork 3 user interface

Motivation:

• current doc contains lot of out-of-date information (text and screenshots)
• current doc does not contain doc on some features

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/)
• Define rules to write documentation (http://docs.titellus.net/geonetwork/en/contributing/writing-documentation.html)
• Add link in the application to the doc (to be done once the documentation is available)

• All page in the documentation contains a link to the corresponding page in the github repository

• Use rst format
• Use readthedoc theme for sphinx

• Build the documentation using sphinx and maven (no need for make as we do now - for easier build)
• Languages: at least in English and optionally in French
• Publication:
• online website http://geonetwork-opensource.org/
• with the application

Demo repository: https://github.com/geosource-catalogue/doc

Proposal Type

• Type: Documentation
• Module: docs

Voting History

• Vote Proposed: 2015/05/04

Participants

• Etienne Taffoureau
• Francois Prunayre