[Geoserver-devel] GSIP 221 mkdocs progress and end-game

GeoServer GeoServer Developer
1

I have made considerable progress on the GSIP-221 script, you can see a preview here: https://jodygarnett.github.io/geoserver/styling/

  • Downloads are now handled
  • Nested admonition directives are now handled

Script is not as forgiving as sphinx-build so I will have some small pull-requests to clean up the rst docs before conversion.

My plan is to:

  1. Give warning, and call for a documentation code freeze (this is disruptive as most PRs update the docs also).

  2. Run the script on all three active branches, producing three pull-requests

  3. Merge each branch in turn, ensuring docs are published to https://docs.geoserver.org as expected

Is there anything I am missing?

···

–
Jody Garnett

2

Hi Jody,
the plan looks good to me, what I’m missing right now is how you get there.
During the meeting it was said you’re working one section at a time, at a superficial level
it seems half of them are still to be covered:
https://jodygarnett.github.io/geoserver/

Each section might hold surprises. So wondering if you need help and who’s up to do so
(calling myself out here, using the little I have to get the wicket upgrade to completion…
besides I can do python only when chatgpt writes it for me :rofl:).

Cheers
Andrea

···

–
Jody Garnett

Regards,

Andrea Aime

==
GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information.

Ing. Andrea Aime
@geowolf
Technical Lead

GeoSolutions Group
phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 339 8844549

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it

Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia.

This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

3

I thanks for the thought, I think I am okay.

I asked for some help when we go live to troubleshoot deploy as that is not something we can test ahead of time.

I was stuck on downloads for a while (this is also not an urgent activity for me).

Now that I am unstuck it is manual work doing a section creating the page navigation tree, repeat. I should have probably made a script for the nav tree creation.

I am being pragmatic in fixing broken relative links and so on in the RST docs (rather than try and make the script robust).

···

–
Jody Garnett

–
Jody Garnett

Regards,

Andrea Aime

==
GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information.

Ing. Andrea Aime
@geowolf
Technical Lead

GeoSolutions Group
phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 339 8844549

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it

Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia.

This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

4

All documentation pages are now converted: https://jodygarnett.github.io/geoserver/

Todo:

  • I have around 20 broken relative links to check

  • The navigation to complete.

  • (You can use search if you wish to review any pages not presently in the nav).

Whew :slightly_smiling_face:

Andrea with respect to who can help, I am comfortable sharing this with the user list and casting a wider net for review assistance.

···

–
Jody Garnett

–
Jody Garnett

–
Jody Garnett

Regards,

Andrea Aime

==
GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information.

Ing. Andrea Aime
@geowolf
Technical Lead

GeoSolutions Group
phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 339 8844549

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it

Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia.

This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail

5

When I last checked in you were working on traversing rst table of contents directives to generate nav tree?

Is it okay if I take on that part, and you can look at re-using it in generation of mkdocs.yml (for use converting other projects).

Thanks for helping move this activity along and encouraging me with python stuff.

···

–
Jody Garnett

–
Jody Garnett

–
Jody Garnett

–
Jody Garnett

Regards,

Andrea Aime

==
GeoServer Professional Services from the experts!

Visit http://bit.ly/gs-services-us for more information.

Ing. Andrea Aime
@geowolf
Technical Lead

GeoSolutions Group
phone: +39 0584 962313

fax: +39 0584 1660272

mob: +39 339 8844549

https://www.geosolutionsgroup.com/

http://twitter.com/geosolutions_it

Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia.

This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail