Transfer ownership of the Node.js API Docs Build/Publish/Tooling to the Web Infra Team
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 20/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- css, html, javascript, node.js
- Domínio
- build-system, documentation, release, tooling
Direção de pesquisa
Revise os diretórios tools/doc e doc, excluindo a pasta api, para entender o escopo de tooling, templates, JavaScript, CSS, build e publicação descrito na solicitação. Considera-se concluído quando a transferência de ownership solicitada estiver formalmente resolvida para esses arquivos e subdiretórios, enquanto a documentação da API permanece excluída.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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)
- Linguagem predominante
- JavaScript
- Estrelas
- 202
- Forks
- 183
- Merge médio
- 13d 12h
- PRs com merge (30d)
- 2
Preparar o ambiente
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de nodejs/admin
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
-
tsc-agenda
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 30/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 30/100
Todas as issues de nodejs/admin
Issues semelhantes
-
bug good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 86/100
amponce/archive-movie-browser#354 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
saayam-for-all/webapp#1870 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Imageomics/OpenCite#66 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
chr15m/twiiit.com#20 ·
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
antropos17/Aegis#629 ·
Mantenedores costumam responder em até 4 dias