Link Python articles to v3 Python SDK #95
Conversation
Signed-off-by: itowlson <ivan.towlson@fermyon.com>
There was a problem hiding this comment.
Thanks for doing this, @itowlson!
@dicej I am not sure of the best approach here - if you think it would be better to make the v3 docs the default/root ones on the Python docs site, and change the v2 URLs instead, then let me know and I can do the spin-docs side of it.
Ideally, the default/root page would be a sort of landing page with links to the docs for all known versions. I considered doing that, but was nervous about breaking existing links (e.g. deep links to specific pages which would presumably go away once the root index.html became a landing page).
If I could go back in time, I would have put the docs for each major version under a /vN/ (where N is the version) prefix to avoid confusion as new versions are released.
Maybe, to avoid breaking existing links entirely, we could crate a landing page with links to all the versions, plus redirects from all unversioned URLs (e.g. /spin-python-sdk/sqlite.html) to that landing page to avoid any 404s. I.e. all the v2 docs would go under /v2/, all the v3 docs would go under /v3/ (etc. for v4 and beyond), and all other urls under /spin-python-sdk/ would redirect to /spin-python-sdk/index.html, which would have links to /spin-python-sdk/v2/index.html, /spin-python-sdk/v3/index.html, etc. What do you think about that?
|
That sounds good @dicej - thanks! |
|
I believe all the CI errors are either:
So I shall force-merge this and hope nothing terrible happens. |
A user on Discord reported that Python was using v3 of the SDK, but links were going to the v2 docs. This PR updates links to point to v3.
@dicej I am not sure of the best approach here - if you think it would be better to make the v3 docs the default/root ones on the Python docs site, and change the v2 URLs instead, then let me know and I can do the spin-docs side of it.