DOCS: Create AboutCode doc system
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 30/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- javascript, markdown
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando la documentazione esistente all’indirizzo aboutcode.readthedocs.io/ e il framework Diátaxis collegato nell’issue. Definisci la struttura proposta e le linee guida per la documentazione del progetto, i file README, i file CONTRIBUTING e le descrizioni dei repository; il lavoro è completato quando il sistema di documentazione è pubblicato e spiega come i progetti AboutCode devono applicarlo.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the Diátaxis framework and its application to AboutCode projects.
Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.
- Lingua principale
- JavaScript
- Stelle
- 9
- Fork
- 17
- Merge medio
- 7h 55m
- PR unite (30g)
- 2
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
- 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 aboutcode-org/www.aboutcode.org
-
Making all post button.Forse già presa @sarthaklole l’ha presa 71 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
aboutcode-org/www.aboutcode.org#117 · 3 commenti ·
-
WWW: Reduce frequency of update-releasesForse di nuovo libera @johnmhoran l’ha presa 52 giorni fa e non c’è nessuna pull request aperta. Apertaci-workflow
Difficoltà 2/5 1-3 ore Idoneità per principianti 45/100
aboutcode-org/www.aboutcode.org#180 · 1 assegnatario ·
-
DOCS: Create new AboutCode stack diagram(s)Forse di nuovo libera @hixvikas l’ha presa 53 giorni fa e non c’è nessuna pull request aperta. Apertadocumentation
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
aboutcode-org/www.aboutcode.org#166 · 1 commento ·
-
WWW: Create About top level page?Forse già presa @pombredanne l’ha presa 155 giorni fa. Apertawebsite
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
aboutcode-org/www.aboutcode.org#164 · 1 reazione · 1 assegnatario ·
-
WWW: Add Initiatives and grant ProjectsForse di nuovo libera @mjherzog l’ha presa 241 giorni fa e non c’è nessuna pull request aperta. Apertaenhancement needs design website
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
aboutcode-org/www.aboutcode.org#141 · 1 assegnatario ·
Tutte le issue di aboutcode-org/www.aboutcode.org
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
-
tech-debt
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
srikanth235/centraid#1155 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
microsoft/monaco-editor#5563 ·
I maintainer di solito rispondono entro 1 giorno
-
Package downloads never retry: getUrlWithResuming's retry catch cannot see a rejected requestAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno