-
-
Notifications
You must be signed in to change notification settings - Fork 6
doc: document the @nodejs/doc-kit subteam #176
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -17,6 +17,12 @@ The maintainers on the Node.js Website Team are responsible for steering the tec | |||||
|
|
||||||
| 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`) | ||||||
|
|
||||||
| 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). | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ### Node.js Web Infra Team (`@nodejs/web-infra`) | ||||||
|
|
||||||
| The Node.js Web Infra Team is responsible for maintaining the Infrastructure relating to Node.js's Web Presence. The Node.js Web Infra team has the responsibilities of: | ||||||
|
|
@@ -56,6 +62,6 @@ While there are special exceptions that require bypassing this policy, all unort | |||||
|
|
||||||
| 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. | ||||||
|
ovflowd marked this conversation as resolved.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| But above all, the Web Team should work together to better the Web Experience for Node.js, aiming to provide the best experience for Node.js users. | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,34 +2,34 @@ | |
|
|
||
| ## Repositories | ||
|
|
||
| | Repository | Everyone | @nodejs/web | @nodejs/nodejs-website | @nodejs/web-infra | @nodejs/web-admins | Notes | | ||
| | ---------------------------------------- | -------- | ----------- | ---------------------- | ----------------- | ------------------ | ------------------------------ | | ||
| | **[nodejs/discord-status-worker][]** | Read | - | - | Maintain | Admin | | | ||
| | **[nodejs/doc-kit][]** | Read | - | Write | Maintain | Admin | | | ||
| | **[nodejs/learn][]** | Read | - | Write | Maintain | Admin | | | ||
| | **[nodejs/node.js.org][]** | Read | Write | - | Maintain | Admin | | | ||
| | **[nodejs/nodejs.dev][]** | Read | - | Write | Maintain | Admin | This repository is _archived_. | | ||
| | **[nodejs/nodejs.org][]** | Read | - | Write | Maintain | Admin | | | ||
| | **[nodejs/nodejs.org-archive][]** | Read | Write | - | Maintain | Admin | This repository is _archived_. | | ||
| | **[nodejs/release-cloudflare-worker][]** | Read | - | - | Maintain | Admin | | | ||
| | **[nodejs/web-team][]** | Read | Triage | - | - | Admin | | | ||
| | **[nodejs/website-cloudflare-worker][]** | - | - | - | Maintain | Admin | | | ||
| | **[nodejs/undici-website][]** | Read | - | - | Maintain | - | | | ||
| | 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 | | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was wondering if they should be |
||
| | **[nodejs/learn][]** | Read | - | Write | - | Maintain | Admin | | | ||
| | **[nodejs/node.js.org][]** | Read | Write | - | - | Maintain | Admin | | | ||
| | **[nodejs/nodejs.dev][]** | Read | - | Write | - | Maintain | Admin | This repository is _archived_. | | ||
| | **[nodejs/nodejs.org][]** | Read | - | Write | - | Maintain | Admin | | | ||
| | **[nodejs/nodejs.org-archive][]** | Read | Write | - | - | Maintain | Admin | This repository is _archived_. | | ||
| | **[nodejs/release-cloudflare-worker][]** | Read | - | - | - | Maintain | Admin | | | ||
| | **[nodejs/web-team][]** | Read | Triage | - | - | - | Admin | | | ||
| | **[nodejs/website-cloudflare-worker][]** | - | - | - | - | Maintain | Admin | | | ||
| | **[nodejs/undici-website][]** | Read | - | - | - | Maintain | - | | | ||
|
|
||
| ## External Services | ||
|
|
||
| | Service | Everyone | @nodejs/web | @nodejs/nodejs-website | @nodejs/web-infra | @nodejs/web-admins | Notes | | ||
| | ---------------------------- | ---------------------------------- | ----------- | ---------------------- | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **[1Password][]** | - | - | - | Admin | Admin | | | ||
| | **[Atlassian Statuspage][]** | [Read](https://status.nodejs.org/) | - | - | App Admin | Org Admin | | ||
| | **[Chromatic][]** | Read | - | Write | Admin | Admin | Access to this service is granted via GitHub authentication. | | ||
| | **[Cloudflare][]** | - | - | - | Read | Admin | Access to this service is controlled by @nodejs/build. Additional access may be granted on a case-by-case basis. | | ||
| | **[Codecov][]** | Read | - | Admin | Admin | Admin | Access to this service is granted via GitHub authentication, and only related to the repository above. | | ||
| | **[Crowdin][]** | Read | - | - | Admin | Admin | Credentials for a user with elevated exist in 1Password. Access to this service may be granted to outside collaborators on a case-by-case, language-by-language basis. | | ||
| | **[Figma][]** | Read | - | Write | - | - | Access to this service is controlled by the OpenJS Foundation and @avivkeller, and only covers website-related design files. | | ||
| | **[HackMD][]** | - | - | - | - | Admin | | | ||
| | **[Sentry][]** | - | - | - | Manager | Owner | | | ||
| | **[Vercel][]** | - | - | - | Developer | Admin | Along with individual access, credentials for a user with elevated exist in 1Password. | | ||
| | Service | Everyone | @nodejs/web | @nodejs/nodejs-website | @nodejs/doc-kit | @nodejs/web-infra | @nodejs/web-admins | Notes | | ||
| | ---------------------------- | ---------------------------------- | ----------- | ---------------------- | --------------- | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **[1Password][]** | - | - | - | - | Admin | Admin | | | ||
| | **[Atlassian Statuspage][]** | [Read](https://status.nodejs.org/) | - | - | - | App Admin | Org Admin | | | ||
| | **[Chromatic][]** | Read | - | Write | - | Admin | Admin | Access to this service is granted via GitHub authentication. | | ||
| | **[Cloudflare][]** | - | - | - | - | Read | Admin | Access to this service is controlled by @nodejs/build. Additional access may be granted on a case-by-case basis. | | ||
| | **[Codecov][]** | Read | - | Admin | - | Admin | Admin | Access to this service is granted via GitHub authentication, and only related to the repository above. | | ||
| | **[Crowdin][]** | Read | - | - | - | Admin | Admin | Credentials for a user with elevated exist in 1Password. Access to this service may be granted to outside collaborators on a case-by-case, language-by-language basis. | | ||
|
ovflowd marked this conversation as resolved.
|
||
| | **[Figma][]** | Read | - | Write | - | - | - | Access to this service is controlled by the OpenJS Foundation and @avivkeller, and only covers website-related design files. | | ||
| | **[HackMD][]** | - | - | - | - | - | Admin | | | ||
| | **[Sentry][]** | - | - | - | - | Manager | Owner | | | ||
| | **[Vercel][]** | - | - | - | - | Developer | Admin | Along with individual access, credentials for a user with elevated exist in 1Password. | | ||
|
|
||
| ## Access Tokens & Automations | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,9 +4,10 @@ This repository contains the governance documentation, workflows, and shared res | |||||
|
|
||||||
| ## Sub-Team Structure | ||||||
|
|
||||||
| The Node.js Web Team consists of two specialized subteams: | ||||||
| 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) | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - **Web Infra Team** ([`@nodejs/web-infra`](https://github.com/orgs/nodejs/teams/web-infra)) - Infrastructure and CI/CD | ||||||
|
|
||||||
| _There is also the **Web Admins Team** ([`@nodejs/web-admins`](https://github.com/orgs/nodejs/teams/web-admins)), which is responsible for administrative operations relating to the Web Team._ | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -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). | ||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
|
|
||||||||||||||||||
| Please note that these tasks should only be performed after an individual's nomination has passed. | ||||||||||||||||||
| To start the nomination process, see [GOVERNANCE.md](../GOVERNANCE.md). | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Tasks | ||||||||||||||||||
|
|
||||||||||||||||||
| - [ ] 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. | ||||||||||||||||||
|
ovflowd marked this conversation as resolved.
|
||||||||||||||||||
| - [ ] Add the **Nominee** to the `#nodejs-website` OpenJS Slack channel. | ||||||||||||||||||
|
Comment on lines
+10
to
+12
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
|
|
||||||||||||||||||
| ### 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. | ||||||||||||||||||
|
ovflowd marked this conversation as resolved.
|
||||||||||||||||||
| - [ ] The **Nominee** should sign their Git commits. | ||||||||||||||||||
|
Comment on lines
+14
to
+18
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is only for web-infra, right?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||||||||||||||||||
|
|
||||||||||||||||||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.