Hi all,
With all ongoing changes on the user interface side, I would like to start a discussion on improving GeoNetwork documentation. This could be the opportunity to rework what we have and also clean what is out of date.
In the user interface, I was thinking on having a closer link between the app & the documentation. Adding some kind of “need help?” links so user could easily access the documentation for the current page for example. Also, having short help text in the app (eg. for each settings) could make the catalog easier to use.
What could be discussed is :
-
What to document ?
a) user & admin guide (using GN, standards docs)
b) sysadmin guide (installing, updating)
c) 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
-
What format ? rst or other.
-
How to build documentation ? currently we need sphinx and extra libs for generating pdf. Markdown to HTML could be easier to add to the maven build.
Any feedback or ideas on this topic are welcomed. We could discuss that on IRC tomorrow and see who is interested in that and then try to build a proposal page.
Cheers.
Francois