theupdateframework / theupdateframework/python-tuf

doc: consider re-adding a "quickstart" document

Aperta
#1,797 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

backlog documentation
Lingua principale
Python
Stelle
1.7k
Fork
304
Merge medio
1g 2h
PR unite (30g)
17

Descrizione

Supersedes https://github.com/theupdateframework/python-tuf/issues/1006

Description of issue or feature request:
#1790 removes QUICKSTART.md because it is severely outdated. The new client and repo examples should be a good replacement to quickly get users familiar with python-tuf and are also easy to discover (e.g. via main README and main menu on RTD).

Still, there might be merit in better framing these examples or adding additional examples as a "quick start"-documentation (note: this is also a silver criteria for the cii badgeapp).

Current behavior:

  • no explicit "quick start" documentation

Expected behavior:

  • consider adding quick start documentation or better frame existing documentation

Guida per i contributori

Apri la 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.

Direzione di ricerca

Esamina gli esempi di client e repository in examples/, quindi traccia come sono collegati da README.md e docs/index.rst dopo che QUICKSTART.md è stato rimosso da #1790. Confronta il materiale esistente con l’obiettivo di quick-start richiesto e il criterio del badge CII; il lavoro è completato quando l’approccio alla documentazione e l’inquadramento o le aggiunte necessari sono chiaramente definiti e implementati.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.