Transfer ownership of the Node.js API Docs Build/Publish/Tooling to the Web Infra Team
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 20/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- css, html, javascript, node.js
- Domaine
- build-system, documentation, release, tooling
Piste de recherche
Examinez les répertoires tools/doc et doc, à l’exclusion du dossier api, afin de comprendre le périmètre du tooling, des templates, de JavaScript, du CSS, du build et de la publication décrit dans la demande. C’est terminé lorsque le transfert de propriété demandé est formellement résolu pour ces fichiers et sous-répertoires, tandis que la documentation de l’API reste exclue.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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)
- Langage dominant
- JavaScript
- Étoiles
- 202
- Forks
- 183
- Merge moyen
- 13 j 12 h
- PR mergées (30 j)
- 2
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de nodejs/admin
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
-
tsc-agenda
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
Toutes les issues de nodejs/admin
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
Les mainteneurs répondent en général sous 1 jour
-
Design only Leadership Survey SLFS
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
bcgov/digital-journeys#2293 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
tursodatabase/turso#9405 ·
Les mainteneurs répondent en général sous 1 jour
-
Toolkit
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour
-
API Bug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
ProjectSidewalk/SidewalkWebpage#5556 ·
Les mainteneurs répondent en général sous 1 jour