Documentation improvement

Date	2014-01-10	Contacts	François Prunayre
Status	On going	Release	2.12
Resources	François, Jean Pommier, ?	Ticket #
Source code
Funding	N/A

Draft proposal

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

Documentation guides:

• user & admin guide (using GN, standards docs)
• sysadmin guide (installing, updating)
• developer guide
• markdown page on github for each module
• service level documentation - a GeoNetwork API ? (could be based on a better service docs in the configuration (eg. https://github.com/geonetwork/core-geonetwork/blob/refactor_editorui/web/src/main/webapp/WEB-INF/config/config-service-statistics.xml#L26)
• JS level API - for building custom apps

Languages: At least like currently english and french (for user & admin guide)

Documentation access:

• online website
• application

To check:

• https://read-the-docs.readthedocs.org/en/latest/getting_started.html

To be added to the doc:

• https://github.com/geonetwork/core-geonetwork/wiki/Multinodes-mode

Format:

• rst ? for guides
• jsdoc for JS level API

Build doc:

• TODO: check maven plugin, grunt for JS API

Proposal Type

• Type: Documentation
• Module: docs

Voting History

• Vote Proposed: TBA

Participants

• All