goss icon indicating copy to clipboard operation
goss copied to clipboard

Final steps to new documentation

Open dklimpel opened this issue 1 year ago • 5 comments

The documentation was migrated to readthedocs.io

This seems to work:

  • stable: https://goss.readthedocs.io/en/stable/containers/kubernetes/ image

  • latest (after PR #904) https://goss.readthedocs.io/en/latest/containers/kubernetes/ image

  • [x] fix problems with PR docs preview (example #924 , error 404 https://goss--924.org.readthedocs.build/en/924/)

  • [ ] redirect https://goss.rocks to https://goss.readthedocs.io/en/stable/ (except https://goss.rocks/install)

  • [ ] update links to documentation in README.md

related to:

  • #856

I do not know the solution for docs preview. Perhaps a settings in readthedocs.io

dklimpel avatar Jun 04 '24 17:06 dklimpel

I'll look into docs preview and see what I can find next week.

aelsabbahy avatar Jun 07 '24 05:06 aelsabbahy

Sorry, been a bit swamped. I'll try to get to this before the end of the week.

aelsabbahy avatar Jun 11 '24 19:06 aelsabbahy

No problem. Everything is ok.

dklimpel avatar Jun 11 '24 20:06 dklimpel

I think previews are fixed now: https://github.com/goss-org/goss/pull/940

Also, I changed the default version to redirect to stable https://goss.readthedocs.io/ now redirects to stable instead of latest. I'm wondering if that makes more sense, or if I should just have the goss.rocks redirect go explicitly to stable and have goss.readthedocs.io point to latest :thinking:

Or I have goss.rocks -> goss.readthedocs.io and that redirects to stable, it's a double redirect, but readthedocs settings would dictate.

(thinking out loud)

aelsabbahy avatar Jun 24 '24 14:06 aelsabbahy

Presumably stable makes more sense than latest, as you usually download the stable binaries as well.

dklimpel avatar Jun 24 '24 14:06 dklimpel