[GeoNetwork-devel] Documentation code freeze!

GeoNetwork GeoNetwork Developer
1

The mkdocs transition (https://github.com/geonetwork/core-geonetwork/wiki/Proposal-mkdocs.md) is presently in progress :slightly_smiling_face:

And this is just a notice that the docs repository (https://github.com/geonetwork/doc) should be considered frozen/archived.

Any content you add to the manual after this point will not be picked up!!

If the admin’s can close the repository for writing it would be best!?

···

–
Jody Garnett

2

If the admin’s can close the repository for writing it would be best!?

Done
Thanks Jody

···

–
Jody Garnett

camptocamp
INNOVATIVE SOLUTIONS
BY OPEN SOURCE EXPERTS

Florent Gravin
Head of Technology Geospatial

3

I have created the draft PR here: https://github.com/geonetwork/core-geonetwork/pull/7329

You can see work in progress here https://jodygarnett.github.io/core-geonetwork/api/

It is taking a while to do each section, but I have improved the conversion script to do batches of pages at a time:

python3 -m translate rst docs/api/*.rst

Notes:

  • I am able to fix simple formatting
  • There are few enough notes and warnings that I am fixing them by hand
  • absolute references between pages, example :ref:csw-configuration, end up as broken links
···

–
Jody Garnett

–
Jody Garnett

camptocamp
INNOVATIVE SOLUTIONS
BY OPEN SOURCE EXPERTS

Florent Gravin
Head of Technology Geospatial

4

The PR is now code complete with all files translated to markdown.

Visual review is available here https://jodygarnett.github.io/core-geonetwork/

  • I am interested in ensuring all the content has made it across safely
    I am especially interested in all the complicated javascript and xml examples

  • The content is now 100% translated using my wrapper script around pandoc:
    python3 -m translate rst manual/docs/**/*.rst

  • This “success” of this script makes it easier to correct or simplify the origional rst files (for such things as incorrect indenting) then to fix up the resulting markdown

  • I made a script to fix the broken “reference” links between pages but have not run it yet

  • Micheal has been experiment with the appearance and may enjoy your feedback also

The PR does have a conflict - some doc/version*.txt files were spell-checked (but I do not have write access to resolve conflicts):

docs/changes2.1.x.txt
docs/changes2.2.x.txt
docs/changes3.8.0-0.txt

···

–
Jody Garnett

–
Jody Garnett

–
Jody Garnett

camptocamp
INNOVATIVE SOLUTIONS
BY OPEN SOURCE EXPERTS

Florent Gravin
Head of Technology Geospatial