improve docs on zarr + cloud storage
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
In the Pangeo gitter chat, @birdsarah helped identify some shortcomings in the documentation about zarr cloud storage (https://github.com/pydata/xarray/blob/master/doc/io.rst#cloud-storage-buckets). We don't mention s3fs or how to use authentication. A more detailed set of examples would probably help people struggling to make the pieces fit together.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the cloud storage buckets section in doc/io.rst, linked in the issue, and review what it currently explains about Zarr cloud storage. Add clear examples covering s3fs and authentication, including how the pieces fit together. Done means users struggling with cloud-backed Zarr can follow the documentation without the current gaps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100