[GeoNetwork-devel] remove doc submodule

GeoNetwork GeoNetwork Developer
1

In 2020 the handling of documentation changed, but the core-geonetwork build was not simplified. Can we remove the doc submodule as it is not actively used?

Checking doc branches:

  • develop (default branch) - last change 3 weeks ago
  • 4.0.x - last change 3 weeks ago
  • And assorted stale branches: 3.0.x, 3.2.x, 3.4.x, …

I do not believe the docs submodule is actively used:

  • core-geonetwork main branch links to docs submodule commit from August 2020
  • core-geonetwork 3.x branch links to docs submodule commit from October 2020

aside: There are some build steps to optionally include the docs in the war if the html files were generated. I have used that to my advantage to include alternate manuals … but since this has not been used since 2020 this complexity should be dropped also.

···

–
Jody Garnett

2

No objection here Jody, the only usage I see is when we update the editor configuration and standard doc (https://github.com/geonetwork/core-geonetwork/blob/main/docs/schema-doc/pom.xml#L74)

cd docs/schema-doc
mvn clean install
cd …/manual
make html_eng

But if it is not a submodule we can easily update it too.

Francois

Le mar. 28 mars 2023 à 21:27, Jody Garnett via GeoNetwork-devel <geonetwork-devel@lists.sourceforge.net> a écrit :

In 2020 the handling of documentation changed, but the core-geonetwork build was not simplified. Can we remove the doc submodule as it is not actively used?

Checking doc branches:

  • develop (default branch) - last change 3 weeks ago
  • 4.0.x - last change 3 weeks ago
  • And assorted stale branches: 3.0.x, 3.2.x, 3.4.x, …

I do not believe the docs submodule is actively used:

  • core-geonetwork main branch links to docs submodule commit from August 2020
  • core-geonetwork 3.x branch links to docs submodule commit from October 2020

aside: There are some build steps to optionally include the docs in the war if the html files were generated. I have used that to my advantage to include alternate manuals … but since this has not been used since 2020 this complexity should be dropped also.

–
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

Francois:

I am not sure I understand how that is working? Is that an xslt producing html output?

···

–
Jody Garnett

4

Exactly. From the XSD for configuring the editor which contains the documentation.
https://github.com/geonetwork/core-geonetwork/blob/main/schemas/config-editor.xsd#L30

But if the doc is not a submodule anymore, that is not a problem.

Le mer. 29 mars 2023 à 09:02, Jody Garnett <jody.garnett@anonymised.com> a écrit :

Francois:

I am not sure I understand how that is working? Is that an xslt producing html output?

–
Jody Garnett

On Tue, Mar 28, 2023 at 11:57 PM Francois Prunayre <fx.prunayre@anonymised.com> wrote:

No objection here Jody, the only usage I see is when we update the editor configuration and standard doc (https://github.com/geonetwork/core-geonetwork/blob/main/docs/schema-doc/pom.xml#L74)

cd docs/schema-doc
mvn clean install
cd …/manual
make html_eng

But if it is not a submodule we can easily update it too.

Francois

Le mar. 28 mars 2023 à 21:27, Jody Garnett via GeoNetwork-devel <geonetwork-devel@lists.sourceforge.net> a écrit :

In 2020 the handling of documentation changed, but the core-geonetwork build was not simplified. Can we remove the doc submodule as it is not actively used?

Checking doc branches:

  • develop (default branch) - last change 3 weeks ago
  • 4.0.x - last change 3 weeks ago
  • And assorted stale branches: 3.0.x, 3.2.x, 3.4.x, …

I do not believe the docs submodule is actively used:

  • core-geonetwork main branch links to docs submodule commit from August 2020
  • core-geonetwork 3.x branch links to docs submodule commit from October 2020

aside: There are some build steps to optionally include the docs in the war if the html files were generated. I have used that to my advantage to include alternate manuals … but since this has not been used since 2020 this complexity should be dropped also.

–
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