doc: consider re-adding a "quickstart" document
I maintainer di solito rispondono entro 10 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
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
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.
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
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 304
- Merge medio
- 9h 25m
- PR unite (30g)
- 14
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di theupdateframework/python-tuf
-
switch to main branch?Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
theupdateframework/python-tuf#3001 ·
I maintainer di solito rispondono entro 10 giorni
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 42/100
theupdateframework/python-tuf#2979 · 1 commento ·
I maintainer di solito rispondono entro 10 giorni
-
Use Immutable ReleasesApertaenhancement github_actions
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
theupdateframework/python-tuf#2920 · 1 commento · 2 reazioni ·
I maintainer di solito rispondono entro 10 giorni
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
theupdateframework/python-tuf#2842 · 3 commenti ·
I maintainer di solito rispondono entro 10 giorni
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
theupdateframework/python-tuf#2836 · 7 commenti ·
I maintainer di solito rispondono entro 10 giorni
Tutte le issue di theupdateframework/python-tuf
Issue simili
-
correction metadata
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
acl-org/acl-anthology#10104 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
bug status/needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
prowler-cloud/prowler#12885 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Bug in GaussianTailProbabilityCalibrator: running_statistics=False still uses a windowed varianceApertabug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
selimfirat/pysad#107 ·
I maintainer di solito rispondono entro 1 giorno
-
bug ci-failure high priority
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
vllm-project/vllm-omni#8194 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno