search

geonetwork / core-geonetwork

GeoNetwork is a catalog application to manage spatially referenced resources. It provides powerful metadata editing and search functions as well as an interactive web map viewer. It is currently used in numerous Spatial Data Infrastructure initiatives across the world.
http://geonetwork-opensource.org/
GNU General Public License v2.0
420 stars 489 forks source link

Need help links broken or incorrect #4426

Open jodygarnett opened 4 years ago

jodygarnett commented 4 years ago

The codebase has a hard coded link to the online documentation:

This link should be dynamically configured, rather than hard coded.

Expected behavior

The correct manual link should be either:

Alternative: link could be set as a configuration option, allowing geonetwork to ship with documentation for use in a disconnected environment.

Additional context

The build server is currently publishing the following manuals:

jodygarnett commented 4 years ago

If I read the code correctly gnGlobalSettings.docUrl may give existing installations a chance to fix themselves?

fxprunayre commented 4 years ago
  • determined dynamically from application version

Some users are pointing to their custom documentation using the setting.

jodygarnett commented 4 years ago

Should anything be done here?

fxprunayre commented 4 years ago
  • master opens 3.8.x manuals (which do not exist)

See https://github.com/geonetwork/core-geonetwork/pull/4442

Should anything be done here?

On the server, if we have only one version, maybe we should setup a redirect instead of having separate folders for 3.x versions.

Then the question is more about if we want to maintain one doc per version.

jodygarnett commented 4 years ago

@fxprunayre ... can we "abandon" one doc per version? Like when 3.10.x starts up we tag 3.8.x and cary on with life ...

fxprunayre commented 4 years ago

can we "abandon" one doc per version?

+1 for me. I don't think it make sense as the doc is not yet really representative of any specific versions.

Like when 3.10.x starts up we tag 3.8.x

I'm not even sure this is really useful and maybe even misleading. https://github.com/geonetwork/doc/branches All the doc work has been done in develop branch in the last 2 years.

jodygarnett commented 4 years ago

For me I am concerned about showing my end-users some documentation for 3.10, when they are running 3.8.x. Perhaps I am just being overlay worried :(

fxprunayre commented 4 years ago

For me I am concerned about showing my end-users some documentation for 3.10, when they are running 3.8.x. Perhaps I am just being overlay worried :(

If you think it is better, no objection for me. But in the past, we published multiple version for 3.2/3.4/3.6/3.8 and none of them have been updated for years and none of them are completely up to date. We made progress during the November codesprint in develop but still there is a lot of stuff to improve. If we clearly highlight what has been added/changed/deprecated using https://geonetwork-opensource.org/manuals/trunk/en/contributing/writing-documentation.html#versionadded-versionchanged-and-deprecated, it may be easier to maintain only one version of the doc with the resources we looks to be able to dedicate to this.