[GeoNetwork-devel] 3.8.x vs 3.10.x documentation location?

GeoNetwork GeoNetwork Developer
1

I am on a bit of a merry chase trying to update user docs for…

3.8x vs 3.10.x confusion

https://geonetwork-opensource.org/docs.html

  • links are to 3.8.x but 3.10.x is latest version?
  • why not use “develop” branch?

https://geonetwork-opensource.org/manuals/3.8.x/en/index.html

  • There is no 3.10.x available?

https://geonetwork-opensource.org/manuals/3.8.x/en/overview/change-log/version-3.10.0.html

  • this page so for 3.8.x version, but provides instructions for updating to 3.10.x?
···

–
Jody Garnett

2

Hi,

I don’t think we have resources to maintain one doc per branches and that’s why we changed the website last year with 'Stable version (3.4/3.6/3.8/3.10)". Making (and using) only one link for all would make sense so that the URL is not misleading users
https://geonetwork-opensource.org/manuals/trunk/en/index.html (maybe a redirect could be set up in the website ?)

and maybe better identify which features is available in which version in the doc.

Cheers.

Francois

Le jeu. 30 janv. 2020 à 00:34, Jody Garnett <jody.garnett@anonymised.com> a écrit :

I am on a bit of a merry chase trying to update user docs for…

3.8x vs 3.10.x confusion

https://geonetwork-opensource.org/docs.html

  • links are to 3.8.x but 3.10.x is latest version?
  • why not use “develop” branch?

https://geonetwork-opensource.org/manuals/3.8.x/en/index.html

  • There is no 3.10.x available?

https://geonetwork-opensource.org/manuals/3.8.x/en/overview/change-log/version-3.10.0.html

  • this page so for 3.8.x version, but provides instructions for updating to 3.10.x?

–
Jody Garnett

GeoNetwork-devel mailing list
GeoNetwork-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geonetwork-devel
GeoNetwork OpenSource is maintained at http://sourceforge.net/projects/geonetwork

3

So is the URL wrong? https://geonetwork-opensource.org/manuals/3.8.x/en/index.html

And the docs generated from trunk? https://geonetwork-opensource.org/manuals/trunk/en/index.html

···

–
Jody Garnett

4

To be checked with Jose or Juan for the server setup, but I think all folders are pointing to the same folder.
Maybe we can simplify this to be https://geonetwork-opensource.org/manuals/en/index.html ?
and setup a permanent redirect for all other URLs?

Francois

Le jeu. 30 janv. 2020 à 16:10, Jody Garnett <jody.garnett@anonymised.com> a écrit :

So is the URL wrong? https://geonetwork-opensource.org/manuals/3.8.x/en/index.html

And the docs generated from trunk? https://geonetwork-opensource.org/manuals/trunk/en/index.html

–
Jody Garnett

On Thu, 30 Jan 2020 at 01:10, Francois Prunayre <fx.prunayre@anonymised.com> wrote:

Hi,

I don’t think we have resources to maintain one doc per branches and that’s why we changed the website last year with 'Stable version (3.4/3.6/3.8/3.10)". Making (and using) only one link for all would make sense so that the URL is not misleading users
https://geonetwork-opensource.org/manuals/trunk/en/index.html (maybe a redirect could be set up in the website ?)

and maybe better identify which features is available in which version in the doc.

Cheers.

Francois

Le jeu. 30 janv. 2020 à 00:34, Jody Garnett <jody.garnett@anonymised.com> a écrit :

I am on a bit of a merry chase trying to update user docs for…

3.8x vs 3.10.x confusion

https://geonetwork-opensource.org/docs.html

  • links are to 3.8.x but 3.10.x is latest version?
  • why not use “develop” branch?

https://geonetwork-opensource.org/manuals/3.8.x/en/index.html

  • There is no 3.10.x available?

https://geonetwork-opensource.org/manuals/3.8.x/en/overview/change-log/version-3.10.0.html

  • this page so for 3.8.x version, but provides instructions for updating to 3.10.x?

–
Jody Garnett

GeoNetwork-devel mailing list
GeoNetwork-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geonetwork-devel
GeoNetwork OpenSource is maintained at http://sourceforge.net/projects/geonetwork

5

I am good with that, can we build straight from docs “develop” to this new location?

···

–
Jody Garnett

6

Thanks for working this out with me Francois.

Okay I caught up with some co-workers, and the build script is now updated: trunk and 3.10.x are now published!

I have a PR for the website (https://github.com/geonetwork/website/pull/17) to link to trunk and the published versions.

I am uncomfortable using master to document a range of functionality across different versions as that is very hard to maintain. Reading Paul’s email … freezing documentation at each release is far cheaper to maintain. To make that work we would need to go back to the 3.8.x branch and change the submodule revision to just before the 3.10.x release notes were added.

···

–
Jody Garnett