Contributor guide needs information about using Zenodo datasets

Aperta
#931 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Read the contributor guide and inspect the docs build mechanism, then compare it with napari/napari#8508 to understand the GDrive workflow. The issue also proposes moving datasets to Cloudflare R2, so first determine whether that proposal is still in scope; done means documenting where contributors should ask for Zenodo datasets and resolving the docs build approach.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

content

📚 New content request

We've had issues with downloading data from Zenodo, which now seems to (?) block downloads from automated tools.

For now, we are storing example datasets in the napari.org gdrive, and linking to them, see napari/napari#8508.

We should:

  1. Update the docs build to use the same mechanism. This doesn't seem to have happened yet — is that causing current docs CI failures? CC @Czaki
  2. Update the contribution guide to mention to ask the core team to store example datasets from Zenodo into the napari GDrive
  3. Create a [email protected] Cloudflare account and use Cloudflare R2 instead of GDrive to store datasets — this will allow us to use zarr datasets that can be big but only download small data for the examples. (Cloudflare R2 has free egress and free storage for up to 10GB.)
Lingua principale
Makefile
Stelle
13
Fork
71
Merge medio
3g 8h
PR unite (30g)
31

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di napari/docs

Tutte le issue di napari/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.