Skip to content
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

Merged
merged 5 commits into from
Dec 17, 2024
Merged

Conversation

dstansby
Copy link
Contributor

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.

@dstansby dstansby added the documentation Improvements to the documentation label Dec 13, 2024
@d-v-b
Copy link
Contributor

d-v-b commented Dec 13, 2024

+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 zarr-specs clears up.

@dstansby dstansby force-pushed the rm-spec-docs branch 2 times, most recently from 606e1d7 to 03dd2ef Compare December 13, 2024 10:36
@dstansby
Copy link
Contributor Author

we will need a place in the docs to publish specs

Do you think it's worth adding an empty page somewhere in this PR, or adding it later alongside the actual content?

@d-v-b
Copy link
Contributor

d-v-b commented Dec 13, 2024

lets wait for when we have actual content

@joshmoore
Copy link
Member

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.

@dstansby
Copy link
Contributor Author

dstansby commented Dec 16, 2024

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/index.rst Outdated Show resolved Hide resolved
docs/conf.py Outdated
@@ -81,6 +82,13 @@
version = get_version("zarr")
release = get_version("zarr")

redirects = {
"docs/spec": "https://zarr-specs.readthedocs.io",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@joshmoore joshmoore left a 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

docs/conf.py Outdated Show resolved Hide resolved
dstansby and others added 2 commits December 16, 2024 17:18
Co-authored-by: Josh Moore <josh@openmicroscopy.org>
@joshmoore joshmoore merged commit a615ee9 into zarr-developers:main Dec 17, 2024
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants