From 8ce2d55a3ae4f1f399c1ef083f9d8da18f4e99c9 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter Date: Sun, 11 Dec 2022 16:09:59 -0500 Subject: [PATCH] docs: Draft maintainer guide IA refactor Resolves https://github.com/eslint/eslint/issues/16647 --- .../src/developer-guide/contributing/working-on-issues.md | 4 ++-- docs/src/{maintainer-guide => maintain}/governance.md | 6 +++--- docs/src/{maintainer-guide => maintain}/index.md | 6 +++--- docs/src/{maintainer-guide => maintain}/issues.md | 8 ++++---- docs/src/{maintainer-guide => maintain}/pullrequests.md | 8 ++++---- docs/src/{maintainer-guide => maintain}/releases.md | 8 ++++---- docs/src/{maintainer-guide => maintain}/working-groups.md | 0 docs/src/pages/index.md | 2 +- 8 files changed, 21 insertions(+), 21 deletions(-) rename docs/src/{maintainer-guide => maintain}/governance.md (98%) rename docs/src/{maintainer-guide => maintain}/index.md (89%) rename docs/src/{maintainer-guide => maintain}/issues.md (99%) rename docs/src/{maintainer-guide => maintain}/pullrequests.md (97%) rename docs/src/{maintainer-guide => maintain}/releases.md (97%) rename docs/src/{maintainer-guide => maintain}/working-groups.md (100%) diff --git a/docs/src/developer-guide/contributing/working-on-issues.md b/docs/src/developer-guide/contributing/working-on-issues.md index 5c929844843..21a61bcf6ec 100644 --- a/docs/src/developer-guide/contributing/working-on-issues.md +++ b/docs/src/developer-guide/contributing/working-on-issues.md @@ -7,10 +7,10 @@ Our public [issues tracker](https://github.com/eslint/eslint/issues) lists all o ## Issue Labels -We use labels to indicate the status of issues. The most complete documentation on the labels is found in the [Maintainer Guide](../../maintainer-guide/issues#when-an-issue-is-opened), but most contributors should find the information on this page sufficient. The most important questions that labels can help you, as a contributor, answer are: +We use labels to indicate the status of issues. The most complete documentation on the labels is found in the [Maintain ESLint](../../maintain/issues#when-an-issue-is-opened) section of the documentation, but most contributors should find the information on this page sufficient. The most important questions that labels can help you, as a contributor, answer are: 1. Is this issue available for me to work on? If you have little or no experience contributing to ESLint, the [`good first issue`](https://github.com/eslint/eslint/labels/good%20first%20issue) label marks appropriate issues. Otherwise, the [`help wanted`](https://github.com/eslint/eslint/labels/help%20wanted) label is an invitation to work on the issue. If you have more experience, you can try working on other issues labeled [`accepted`](https://github.com/eslint/eslint/labels/accepted). Conversely, issues not yet ready to work on are labeled `triage`, `evaluating`, and/or `needs bikeshedding`, and issues that cannot currently be worked on because of something else, such as a bug in a dependency, are labeled `blocked`. -1. What is this issue about? Labels describing the nature of issues include `bug`, `enhancement`, `feature`, `question`, `rule`, `documentation`, `core`, `build`, `cli`, `infrastructure`, `breaking`, and `chore`. These are documented in the [Maintainer Guide](../../maintainer-guide/issues#types-of-issues). +1. What is this issue about? Labels describing the nature of issues include `bug`, `enhancement`, `feature`, `question`, `rule`, `documentation`, `core`, `build`, `cli`, `infrastructure`, `breaking`, and `chore`. These are documented in the [Maintain ESLint](../../maintain/issues#types-of-issues) section. 1. What is the priority of this issue? Because we have a lot of issues, we prioritize certain issues above others. The following is the list of priorities, from highest to lowest: 1. **Bugs** - problems with the project are actively affecting users. We want to get these resolved as quickly as possible. diff --git a/docs/src/maintainer-guide/governance.md b/docs/src/maintain/governance.md similarity index 98% rename from docs/src/maintainer-guide/governance.md rename to docs/src/maintain/governance.md index 6b77d9f8952..b6c98bda3f1 100644 --- a/docs/src/maintainer-guide/governance.md +++ b/docs/src/maintain/governance.md @@ -2,7 +2,7 @@ title: Governance eleventyNavigation: key: governance - parent: maintainer guide + parent: maintain eslint title: Governance order: 4 @@ -76,7 +76,7 @@ A Committer who shows an above-average level of contribution to the project, par #### Process for Adding Committers -1. Send email congratulating the new committer and confirming that they would like to accept. This should also outline the responsibilities of a committer with a link to the maintainer guide. +1. Send email congratulating the new committer and confirming that they would like to accept. This should also outline the responsibilities of a committer with a link to the Maintain ESLint section of the docs (). 1. Add the GitHub user to the "ESLint Team" team 1. Add committer email to the ESLint team mailing list 1. Invite to Discord team channel @@ -143,7 +143,7 @@ A Reviewer is invited to become a TSC member by existing TSC members. A nominati 1. Add the GitHub user to the "ESLint TSC" GitHub team 1. Set the GitHub user to be have the "Owner" role for the ESLint organization -1. Send a welcome email with a link to the [maintainer guide](./) and instructions for npm 2FA. +1. Send a welcome email with a link to the [Maintain ESLint](./) section and instructions for npm 2FA. 1. Invite to the Discord TSC channel 1. Make the TSC member an admin on the ESLint team mailing list 1. Add the TSC member to the recurring TSC meeting event on Google Calendar diff --git a/docs/src/maintainer-guide/index.md b/docs/src/maintain/index.md similarity index 89% rename from docs/src/maintainer-guide/index.md rename to docs/src/maintain/index.md index 6e96eccf6c9..8987a07127e 100644 --- a/docs/src/maintainer-guide/index.md +++ b/docs/src/maintain/index.md @@ -1,8 +1,8 @@ --- -title: Maintainer Guide +title: Maintain ESLint eleventyNavigation: - key: maintainer guide - title: Maintainer Guide + key: maintain eslint + title: Maintain ESLint order: 3 --- diff --git a/docs/src/maintainer-guide/issues.md b/docs/src/maintain/issues.md similarity index 99% rename from docs/src/maintainer-guide/issues.md rename to docs/src/maintain/issues.md index 977fc3d891c..394019df066 100644 --- a/docs/src/maintainer-guide/issues.md +++ b/docs/src/maintain/issues.md @@ -1,9 +1,9 @@ --- -title: Managing Issues +title: Manage Issues eleventyNavigation: - key: managing issues - parent: maintainer guide - title: Managing Issues + key: manage issues + parent: maintain eslint + title: Manage Issues order: 1 --- diff --git a/docs/src/maintainer-guide/pullrequests.md b/docs/src/maintain/pullrequests.md similarity index 97% rename from docs/src/maintainer-guide/pullrequests.md rename to docs/src/maintain/pullrequests.md index 9c43ccad4ad..6705a81d603 100644 --- a/docs/src/maintainer-guide/pullrequests.md +++ b/docs/src/maintain/pullrequests.md @@ -1,9 +1,9 @@ --- -title: Reviewing Pull Requests +title: Review Pull Requests eleventyNavigation: - key: reviewing pull requests - parent: maintainer guide - title: Reviewing Pull Requests + key: review pull requests + parent: maintain eslint + title: Review Pull Requests order: 2 --- diff --git a/docs/src/maintainer-guide/releases.md b/docs/src/maintain/releases.md similarity index 97% rename from docs/src/maintainer-guide/releases.md rename to docs/src/maintain/releases.md index 9b58eb92e6f..10d681a4fd8 100644 --- a/docs/src/maintainer-guide/releases.md +++ b/docs/src/maintain/releases.md @@ -1,9 +1,9 @@ --- -title: Managing Releases +title: Manage Releases eleventyNavigation: - key: managing releases - parent: maintainer guide - title: Managing Releases + key: manage releases + parent: maintain eslint + title: Manage Releases order: 3 --- diff --git a/docs/src/maintainer-guide/working-groups.md b/docs/src/maintain/working-groups.md similarity index 100% rename from docs/src/maintainer-guide/working-groups.md rename to docs/src/maintain/working-groups.md diff --git a/docs/src/pages/index.md b/docs/src/pages/index.md index 5f1b6933af7..7de31776184 100644 --- a/docs/src/pages/index.md +++ b/docs/src/pages/index.md @@ -15,6 +15,6 @@ as well as guides for migrating from earlier versions of ESLint. Intended for contributors to ESLint and people who wish to extend ESLint. Contains information about contributing to ESLint; creating custom rules, configurations, plugins, and formatters; and information about our architecture and Node.js API. -## [Maintainer Guide](maintainer-guide/) +## [Maintain ESLint](maintain-guide/) Intended for maintainers of ESLint.