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 & 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
Sections to be added to the doc:
Formats:
- rst ? for guides
- jsdoc for JS level API (eg. https://github.com/geonetwork/core-geonetwork/blob/develop/web-ui/src/main/resources/catalog/components/edit/FieldsDirective.js#L36)
- small videos ?
Build doc:
- Sphinx is used for RST format
- JS API : https://github.com/geonetwork/core-geonetwork/tree/develop/web-ui-docs
- Service level API : Use XSLT (https://github.com/geonetwork/core-geonetwork/blob/develop/web-ui-docs/generate-jeeves-services-doc.xsl) to extract documentation from WEB-INF/config/*.xml.
- To evaluate ? http://maven.apache.org/doxia/
- To evaluate ? https://read-the-docs.readthedocs.org/en/latest/getting_started.html
- Type: Documentation
- Module: docs
- Vote Proposed: TBA
- All