theupdateframework / theupdateframework/python-tuf
Restructure docs directory
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 304
- Merge medio
- 1g 2h
- PR unite (30g)
- 17
Descrizione
Description of issue or feature request:
Current behavior:
No clear distinction of different documentation types in docs directory.
Expected behavior:
Clear distinction of different documentation types in docs directory, e.g. along the following categories:
- adr
- rtd (e.g. see
sphinx-quickstartdir scaffolding) - misc docs that are neither an adr, nor rendered on rtd (?)
related: see #1848
Guida per i contributori
Apri 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.
Direzione di ricerca
Inizia esaminando la directory docs esistente e la issue correlata #1848 per identificare i tipi di documentazione attualmente mescolati. Definisci una struttura che distingua gli ADRs, i contenuti di Read the Docs e i documenti vari; il lavoro è completato quando le categorie sono chiaramente separate e la documentazione esistente continua a essere inclusa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- 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