Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Write documentation on best practices for researcher DB access

Aperta
#14 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Leggi il workflow di build della documentazione in .github/workflows/build_docs.yml e le indicazioni in docs.ooni.org/meta/, incluso il modo in cui viene costruita la documentazione. Aggiungi in docs.ooni.org un documento o una sezione che descriva le buone pratiche per l’accesso dei ricercatori ai database, facendo in modo che il risultato venga incluso nel build della documentazione.

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

Descrizione

docs good first issue

During the review of the OONI Data & Systems Usage Policy document it came up that:

Maybe at some point it would be a good idea to add a "good practices" section with this kind of thing
@LDiazN

It would be great to write this up as part of a document inside of docs.ooni.org: https://github.com/ooni/data/blob/main/.github/workflows/build_docs.yml
also: https://docs.ooni.org/meta/
and https://docs.ooni.org/meta/#how-documentation-is-built

Lingua principale
TypeScript
Stelle
3
Fork
2
Merge medio
6g 7h
PR unite (30g)
3

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 ooni/docs

Tutte le issue di ooni/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.