Skip to content

docs: replace getting_started page with quickstart #2590

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 15 commits into from
Jan 3, 2025
Merged

docs: replace getting_started page with quickstart #2590

merged 15 commits into from
Jan 3, 2025

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented Dec 29, 2024 •
edited
Loading

This PR replaces Zarr's Getting Started page with a proper Quickstart.

Notes for reviewers:

This was referenced Dec 29, 2024
Merged
Merged
@jhamman jhamman added the documentation Improvements to the documentation label Dec 29, 2024
@jhamman jhamman mentioned this pull request Dec 29, 2024
Merged
@jhamman jhamman added this to the 3.0.0 milestone Dec 30, 2024
normanrz
normanrz reviewed Dec 30, 2024
View reviewed changes
@jhamman
Copy link
Member Author

jhamman commented Jan 1, 2025

FYI - the build here will fail until #2463 goes in.

dstansby
dstansby previously requested changes Jan 2, 2025
View reviewed changes
Copy link
Contributor

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

I think this needs a re-direct for the getting started page that's been deleted? Also the doc build is failing - I guess that will be fixed when other stuff is merged.

Base automatically changed from docs/3.0-user-guide to main January 3, 2025 14:31
@dstansby dstansby force-pushed the docs/3.0-quickstart branch 2 times, most recently from 8799087 to f6be517 Compare January 3, 2025 14:49
@jhamman jhamman enabled auto-merge (squash) January 3, 2025 22:56
@jhamman jhamman disabled auto-merge January 3, 2025 22:56
@jhamman jhamman enabled auto-merge (squash) January 3, 2025 23:00
dcherian
dcherian reviewed Jan 3, 2025
View reviewed changes
docs/quickstart.rst Outdated
[0.4335856 , 0.7565437 , 0.7828931 , ..., 0.48119593, 0.66220033,
0.6652362 ]], shape=(100, 100), dtype=float32)

Cloud Storage Backends
Copy link
Contributor

Choose a reason for hiding this comment

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

I would merge with the previous section or at least talk about it before ZipStore

dcherian
dcherian approved these changes Jan 3, 2025
View reviewed changes
Copy link
Contributor

@dcherian dcherian left a comment

Choose a reason for hiding this comment

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

LGTM modulo comment about introducing cloud storage before ZipStore

@jhamman jhamman merged commit 23beb8f into main Jan 3, 2025
33 checks passed
@jhamman jhamman deleted the docs/3.0-quickstart branch January 4, 2025 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@normanrz normanrz normanrz left review comments

@dcherian dcherian dcherian approved these changes

+1 more reviewer

@dstansby dstansby dstansby left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
documentation Improvements to the documentation
Projects
Zarr-Python - 3.0
Status: Done
Milestone
3.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@jhamman @normanrz @dcherian @dstansby