Transfer ownership of the Node.js API Docs Build/Publish/Tooling to the Web Infra Team
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 202
- Fork
- 183
- Merge medio
- 2m
- PR unite (30g)
- 1
Descrizione
I'd like to formally request that the ownership of https://github.com/nodejs/node/tree/main/tools/doc and https://github.com/nodejs/node/tree/main/doc (all files and subfolders except the api folder, which contains the API docs) be transferred to the Web Infra team.
The reasoning behind this is that it makes sense for the Web Infra team to own the tooling (generation, HTML templates, JavaScript code, CSS styles, etc), build (generation, output, compilation, dependencies), and publish (nodejs.org domain publishing, upload, etc) to the Web Infra team.
We aim to own and maintain these pieces of code and software. We have cool plans for the future of the API docs.
Note: This has nothing to do with the API metadata proposal (from Next-10) since that is a proposal of the change and restructuring of the API docs themselves (the actual Markdown files, and their folder structure)
With the change of ownership for the tooling we aim to simply apply new modern tooling and redesign the API docs to look like the Node.js Website, not intent of changing the structure of the Markdown (the name of the files, amount of output files in HTML and source Markdown would remain the same)
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
Esamina le directory tools/doc e doc, escludendo la cartella api, per comprendere l'ambito di tooling, template, JavaScript, CSS, build e publishing descritto nella richiesta. Il lavoro è completato quando il trasferimento di ownership richiesto è formalmente risolto per quei file e sottodirectory, mentre la documentazione dell'API rimane esclusa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- css, html, javascript, node.js
- Ambito
- build-system, documentation, release, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 20/100