Update from GeoServer translate work

[jodygarnett]

Peter has been working on the translate script filling in gaps for docs.geoserver.org - which is much harder than other projects attempted.

• UTF-8 encoding fixes
• RST admonition fix

[jodygarnett]

@peter-afrigis can we start to merge this bit by bit, rather than have such a long standing thing?

[petersmythe]

@peter-afrigis can we start to merge this bit by bit, rather than have such a long standing thing?

48 hours later, I am still fighting nested tables.

[jodygarnett]

When we get into things like nested tables, it starts to become worthwhile to edit the RST origional.

How many nested tables are there?

And if you are fighting hard it is "faster" to steal a page example over to this project for rapid troubleshooting.

[jodygarnett]

@peter-afrigis for https://geoserver.org/geoserver/en/user/extensions/authkey/#installation page the variables are not being filled in like {{ release }}.

I think that is done using macros (which makes pages slower then sphinx) so I turned it off by default. To enable it for a page you have to add a snippet to the top of the page.

Generating locally I see the page does contain:

---
render_macros: true
---

So I expect the substitutions variables changed in sphinx over the time period. I was working to make main generate examples that could be used (rather than always recommending SNAPSHOTs).

main config.py has:

version = pomtree.getroot().find("{http://maven.apache.org/POM/4.0.0}version").text
snapshot = version.find('SNAPSHOT') != -1
if snapshot:
    print("Building snapshot docs version", version)
else:
    print("Building release docs version", version)
    

# The relacement |release| most recent release version, including alpha/beta/rc tags.
# This should be updated after each release
release = '2.28.0'
if not snapshot:
  release = version
...
branch = 'main'
series = '3.x'
...
rst_epilog = "\n" \
 ".. |branch| replace:: "+branch+"\n" \
 ".. |series| replace:: "+series

So the valid substations should be:

• branch = main
• series = 3.x
• version = 3.0-SNAPSHOT
• release = 2.28.0

And using that we should be able to build up the download macros, reading the logic config also has:

• community = 3.0-SNAPSHOT

config.py uses these values for external link generation:

'download_extension': (download_extension,'geoserver-'+release+'-%s-plugin.zip')
'nightly_extension': (nightly_extension,'geoserver-'+community+'-%s-plugin.zip'),

[jodygarnett]

There is some logic here for config handling external links:

• https://github.com/petersmythe/translate/blob/main/mkdocs_translate/translate.py#L1212

And the example translate.yml has several:

extlinks:
  github: https://github.com/jodygarnett/translate/blob/main/%s
  tag: https://github.com/jodygarnett/translate/releases/tag/{{ release }}|Release {{ release }}
  squidfunk: https://squidfunk.github.io/mkdocs-material/%s

But I do not see a translate.yml for external links in the geoserver user docs.

[jodygarnett]

I tried creating a local translate.yml with extlinks and running locally but did not get anywhere.

Let's catch up, and if needed remove this stuff.