Skip to content

doc: document the @nodejs/doc-kit subteam - #176

Open
ovflowd wants to merge 3 commits into
mainfrom
docs/doc-kit-team
Open

ovflowd wants to merge 3 commits into
mainfrom
docs/doc-kit-team

Conversation

@ovflowd

@ovflowd ovflowd commented Aug 29, 2026

Copy link
Copy Markdown
Member

We created the @nodejs/doc-kit team on GitHub so contributors to nodejs/doc-kit can be onboarded without handing them the whole Web Team surface, and the docs here never caught up. This PR documents it:

  • PERMISSIONS.md: new @nodejs/doc-kit column. The only non-empty cell is Maintain on nodejs/doc-kit, everything else, including every external service, is -
  • GOVERNANCE.md: new section covering the team, its scope, and its nomination process, which mirrors @nodejs/web-infra
  • MEMBERS.md: new section, seeded with the current members of the GitHub team
  • onboarding/doc-kit.md: onboarding checklist, deliberately much shorter than web-infra's
  • README.md: two subteams becomes three

The scope is intentionally narrow: Maintain on nodejs/doc-kit and nothing else. No publishing access for now, so no 1Password vault, no Vercel, no npm scope ownership, those stay with @nodejs/web-infra. Releases still go out through the repo's automated workflow via npm trusted publishing, so this doesn't block anyone from cutting one.

Heads up that touching GOVERNANCE.md pulls in @nodejs/tsc via CODEOWNERS. Happy to split that file into its own PR if y'all would rather land the rest first.

Refs: nodejs/admin#1091

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 29, 2026 13:15
@ovflowd
ovflowd requested a review from a team as a code owner August 29, 2026 13:15

This comment was marked as low quality.

Comment thread onboarding/doc-kit.md
Comment on lines +14 to +18
### Recommendations

- [ ] The **Nominee** should have some form of physical 2FA (i.e. Yubikey) or passkey enabled on their GitHub account.
- [ ] The **Nominee** should have any SSH or GPG key attached to their GitHub account have passphrases and/or be stored on a physical 2FA device.
- [ ] The **Nominee** should sign their Git commits.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only for web-infra, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everyone should be doing these things, they improve our security posture.

I think web-infra must do these things?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, I think we could leave as is, but also fine either removing or copy pasting this to the other team-specific recommendations.

Comment thread onboarding/doc-kit.md Outdated
Comment thread GOVERNANCE.md Outdated
Comment thread GOVERNANCE.md Outdated
Comment thread PERMISSIONS.md Outdated
ovflowd and others added 2 commits August 30, 2026 02:00
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Aviv Keller <me@aviv.sh>
Clarified the scope and access rights of the Node.js Doc Kit Team.
Comment thread PERMISSIONS.md
| Repository | Everyone | @nodejs/web | @nodejs/nodejs-website | @nodejs/doc-kit | @nodejs/web-infra | @nodejs/web-admins | Notes |
| ---------------------------------------- | -------- | ----------- | ---------------------- | --------------- | ----------------- | ------------------ | ----------------------------------------------------------------------------------------------------------- |
| **[nodejs/discord-status-worker][]** | Read | - | - | - | Maintain | Admin | |
| **[nodejs/doc-kit][]** | Read | - | Write | Maintain | Maintain | Admin | |

@bmuenzenmeyer bmuenzenmeyer Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the doc-kit team shouldn't be maintain, right?

image
Suggested change
| **[nodejs/doc-kit][]** | Read | - | Write | Maintain | Maintain | Admin | |
| **[nodejs/doc-kit][]** | Read | - | Write | Write | Maintain | Admin | |

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was wondering if they should be maintain on doc-kit and maybe write on nodejs.org/learn as they're downstream consumers of doc-kit. But also completely fine if they only get write on doc-kit and nothing else.

Comment thread onboarding/doc-kit.md
Comment on lines +10 to +12
- [ ] Add the **Nominee** to the [`@nodejs/doc-kit`](https://github.com/orgs/nodejs/teams/doc-kit) team on GitHub.
- [ ] An OpenJS Slack Admin should add their Slack account to the `nodejs-website-team` team.
- [ ] Add the **Nominee** to the `#nodejs-website` OpenJS Slack channel.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] Add the **Nominee** to the [`@nodejs/doc-kit`](https://github.com/orgs/nodejs/teams/doc-kit) team on GitHub.
- [ ] An OpenJS Slack Admin should add their Slack account to the `nodejs-website-team` team.
- [ ] Add the **Nominee** to the `#nodejs-website` OpenJS Slack channel.
- [ ] Add the **Nominee** to the [`@nodejs/doc-kit`](https://github.com/orgs/nodejs/teams/doc-kit) team on GitHub.
- [ ] An OpenJS Slack Admin should add their Slack account to the `nodejs-website-team` team.
- [ ] Add the **Nominee** to the following OpenJS Slack channels:
- [ ] `#nodejs-website`
- [ ] `#nodejs-web-infra`

Comment thread GOVERNANCE.md

Members of this team are nominated through the guidelines provided in the [Contributing Guidelines](https://github.com/nodejs/nodejs.org/blob/main/CONTRIBUTING.md#becoming-a-collaborator) within the [nodejs.org](https://github.com/nodejs/nodejs.org) repository. After a passed nomination, members should submit a PR to add themselves to the list of current members, shown within [MEMBERS.md](https://github.com/nodejs/web-team/blob/main/MEMBERS.md).

### Node.js Doc Kit Team (`@nodejs/doc-kit`)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Node.js Doc Kit Team (`@nodejs/doc-kit`)
### Node.js doc-kit Team (`@nodejs/doc-kit`)

Comment thread GOVERNANCE.md

The Node.js doc-kit Team is responsible for the day-to-day technical development of [nodejs/doc-kit](https://github.com/nodejs/doc-kit), the tooling that generates the Node.js API documentation. This covers adding features, reviewing and landing pull requests, fixing bugs and security issues, and the general maintenance of the repository.

Members of this team are nominated through the same process as the [Node.js Web Infra Team](#nodejs-web-infra-team-nodejsweb-infra): either by the Node.js Technical Steering Committee (TSC) or by the Node.js Web Team. Current members of the Node.js Doc Kit Team may also nominate individuals. After a passed nomination, members should submit a PR to add themselves to the list of current members, shown within [MEMBERS.md](https://github.com/nodejs/web-team/blob/main/MEMBERS.md).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Members of this team are nominated through the same process as the [Node.js Web Infra Team](#nodejs-web-infra-team-nodejsweb-infra): either by the Node.js Technical Steering Committee (TSC) or by the Node.js Web Team. Current members of the Node.js Doc Kit Team may also nominate individuals. After a passed nomination, members should submit a PR to add themselves to the list of current members, shown within [MEMBERS.md](https://github.com/nodejs/web-team/blob/main/MEMBERS.md).
Members of this team are nominated through the same process as the [Node.js Web Infra Team](#nodejs-web-infra-team-nodejsweb-infra): either by the Node.js Technical Steering Committee (TSC) or by the Node.js Web Team. Current members of the Node.js doc-kit Team may also nominate individuals. After a passed nomination, members should submit a PR to add themselves to the list of current members, shown within [MEMBERS.md](https://github.com/nodejs/web-team/blob/main/MEMBERS.md).

Comment thread GOVERNANCE.md
As seen above, the different teams under the Node.js Web Team umbrella are responsible for having the oversight on different aspects of Node.js's Web-related projects. However, it is important to note that the Node.js Web Team is not a set of siloed teams, but rather a set of teams that work together to achieve the same goal: Providing the best Web Experience for Node.js.

Following this line of thought, the Web Infra Team is responsible for the technical aspects of the Node.js Website (Infrastructure, Framework, CI/CD, etc); The Website Team is responsible for the day-to-day development of the Node.js Website.
Following this line of thought, the Web Infra Team is responsible for the technical aspects of the Node.js Website (Infrastructure, Framework, CI/CD, etc); The Website Team is responsible for the day-to-day development of the Node.js Website; The Doc Kit Team is responsible for the day-to-day development of the API documentation tooling that the Website consumes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Following this line of thought, the Web Infra Team is responsible for the technical aspects of the Node.js Website (Infrastructure, Framework, CI/CD, etc); The Website Team is responsible for the day-to-day development of the Node.js Website; The Doc Kit Team is responsible for the day-to-day development of the API documentation tooling that the Website consumes.
Following this line of thought, the Web Infra Team is responsible for the technical aspects of the Node.js Website (Infrastructure, Framework, CI/CD, etc); The Website Team is responsible for the day-to-day development of the Node.js Website; The doc-kit Team is responsible for the day-to-day development of the API documentation tooling that the Website consumes.

Comment thread README.md
The Node.js Web Team consists of three specialized subteams:

- **Website Team** ([`@nodejs/nodejs-website`](https://github.com/orgs/nodejs/teams/nodejs-website)) - Day-to-day website development
- **Doc Kit Team** ([`@nodejs/doc-kit`](https://github.com/orgs/nodejs/teams/doc-kit)) - Day-to-day development of [nodejs/doc-kit](https://github.com/nodejs/doc-kit)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Doc Kit Team** ([`@nodejs/doc-kit`](https://github.com/orgs/nodejs/teams/doc-kit)) - Day-to-day development of [nodejs/doc-kit](https://github.com/nodejs/doc-kit)
- **doc-kit Team** ([`@nodejs/doc-kit`](https://github.com/orgs/nodejs/teams/doc-kit)) - Day-to-day development of [nodejs/doc-kit](https://github.com/nodejs/doc-kit)

Comment thread onboarding/doc-kit.md
@@ -0,0 +1,19 @@
# @nodejs/doc-kit Onboarding

This document is an outline of the tasks necessary to onboard a new member of the Doc Kit team (@nodejs/doc-kit).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This document is an outline of the tasks necessary to onboard a new member of the Doc Kit team (@nodejs/doc-kit).
This document is an outline of the tasks necessary to onboard a new member of the doc-kit team (@nodejs/doc-kit).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants