-
-
Notifications
You must be signed in to change notification settings - Fork 308
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove specs pages from docs #2555
Conversation
1473c0c
to
f87ddf9
Compare
+1 for removing pages that are currently empty, but I think we will need a place in the docs to publish specs for things like consolidated metadata, dtypes, and codecs until the logjam over in |
606e1d7
to
03dd2ef
Compare
03dd2ef
to
66100c3
Compare
Do you think it's worth adding an empty page somewhere in this PR, or adding it later alongside the actual content? |
lets wait for when we have actual content |
I'm typically anti breaking any URLs. I'd suggest we redirect the spec/vX pages to the new homes and keep the top-level page also with the links to the new homes. |
I've redirected the deleted pages. I'm +1 to getting rid of all these pages and cleaning the top level navigation up a bit, as I'm not sure there's much point keeping the top-level page given it just links out without any of it's own content. |
docs/conf.py
Outdated
@@ -81,6 +82,13 @@ | |||
version = get_version("zarr") | |||
release = get_version("zarr") | |||
|
|||
redirects = { | |||
"docs/spec": "https://zarr-specs.readthedocs.io", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm struggling to test these under https://zarr--2555.org.readthedocs.build/en/2555/
https://zarr--2555.org.readthedocs.build/en/2555/spec/index.html e.g. is 404
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be working now - the redirect is from https://zarr--2555.org.readthedocs.build/en/2555/spec.html (corresponding to https://zarr.readthedocs.io/en/stable/spec.html).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor typo and some issues with the redirects
Co-authored-by: Josh Moore <josh@openmicroscopy.org>
These are just empty pages now, so I've replaced them with a link to the zarr specs on the home page. This cleans up the top level table of contents a little bit.