Documentation improvement
| Date | 2014-01-10 | Contacts | François Prunayre |
| Status | On going | Release | 2.12 |
| Resources | François, Jean Pommier, Etienne Taffoureau | Ticket # | |
| Source code | |||
| Funding | N/A | ||
Draft proposal
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 guide (using GN, standards docs)
- admin guide (eg. settings, CSW, users & groups)
- maintainer guide (eg. installing, updating, backup)
- 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) and Spring MVC Javadoc (move to http://projects.spring.io/spring-hateoas/)
- JS level API - for building custom apps
Languages:
- user, admin and maintainer guides at least in english and french
- dev guide in english only
- set up transifex for translation ? https://www.transifex.com/projects/p/core-geonetwork/
Documentation access:
- online website
- from the application
- Start a new documentation from scratch
- Define table of content
- Concentrate on the main part of the application
- Media
- Update screenshot using GN3 UI
- Create videos for main user stories
- Use markdown as format
- Build doc using
- http://www.mkdocs.org/ for creating website
- https://github.com/chjj/marked/ for embedded pages into the webapp
New sections to be added to the doc:
-
https://github.com/geonetwork/core-geonetwork/wiki/Multinodes-mode
-
TODO
-
Proposition de plan pour la documentation en français:
-
Introduction
-
Configurer son catalogue >> introduction
- Définir les paramètres du catalogue
- Gérer des utilisateurs et groupes
- Gérer les nomenclatures >> introduction
- Thésaurus
- Annuaires
- Standards de métadonnées
- Gérer le contenu de son catalogue >> introduction
- Créer des modèles de fiches
- Créer de nouvelles fiches
- Importer de nouvelles fiches
- Moissonner des catalogues externes
- Gérer son stock de métadonnées
- Rendre disponible ses métadonnées >> introduction
- Publier ses métadonnées
- Rechercher des ressources
- Rendre accessible ses métadonnées dans un service CSW
- Informations sur le contenu du catalogue >> introduction
- Statistiques et statuts
- Rapports
- Glossaire
- Type: Documentation
- Module: docs
- Vote Proposed: TBA
- All