Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docs: Update page titles, section landing pages, and side TOC (#16760)
* allow crawling

* trigger deploy

* Remove todo

* remove noindex

* remove unused files

* add files to delete

* remove unwanted files

* Revert changes nec for link checking

* docs: update docs TOC and page names

Resolves #16720

* draft extend eslint and contribute to eslint TOCs/titles

* update maintainer guide pages names

* update titles and links to them for use docs

* rename links to additional page names

* update landing pages

* rename ignore code -> ignore files

* small fixes

* update site main page

* page name updates

* fix title case

* fix top lvl order

* Update docs/src/contribute/index.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* move up get src code page

* Update docs/src/contribute/index.md

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* Apply suggestions from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* implement md feedback

---------

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
  • Loading branch information
3 people committed Jan 28, 2023
1 parent 333c712 commit ed60afd
Show file tree
Hide file tree
Showing 46 changed files with 254 additions and 214 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -10,9 +10,9 @@ This project adheres to the [Open JS Foundation Code of Conduct](https://eslint.

Before filing an issue, please be sure to read the guidelines for what you're reporting:

* [Bug Report](https://eslint.org/docs/latest/contribute/report-bugs)
* [Report Bugs](https://eslint.org/docs/latest/contribute/report-bugs)
* [Propose a New Rule](https://eslint.org/docs/latest/contribute/propose-new-rule)
* [Proposing a Rule Change](https://eslint.org/docs/latest/contribute/propose-rule-change)
* [Propose a Rule Change](https://eslint.org/docs/latest/contribute/propose-rule-change)
* [Request a Change](https://eslint.org/docs/latest/contribute/request-change)

To report a security vulnerability in ESLint, please use our [HackerOne program](https://hackerone.com/eslint).
Expand Down
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -10,10 +10,10 @@
# ESLint

[Website](https://eslint.org) |
[Configuring](https://eslint.org/docs/latest/use/configure) |
[Configure ESLint](https://eslint.org/docs/latest/use/configure) |
[Rules](https://eslint.org/docs/rules/) |
[Contributing](https://eslint.org/docs/latest/contribute) |
[Reporting Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
[Contribute to ESLint](https://eslint.org/docs/latest/contribute) |
[Report Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
[Code of Conduct](https://eslint.org/conduct) |
[Twitter](https://twitter.com/geteslint) |
[Mailing List](https://groups.google.com/group/eslint) |
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
Expand Up @@ -54,3 +54,4 @@
"node": ">=14.0.0"
}
}

4 changes: 2 additions & 2 deletions docs/src/contribute/architecture/index.md
Expand Up @@ -2,9 +2,9 @@
title: Architecture
eleventyNavigation:
key: architecture
parent: developer guide
parent: contribute to eslint
title: Architecture
order: 1
order: 5
---

:::img-container
Expand Down
11 changes: 5 additions & 6 deletions docs/src/contribute/development-environment.md
@@ -1,11 +1,10 @@
---
title: Development Environment
title: Set up a Development Environment
eleventyNavigation:
key: set up a development environment
parent: developer guide
title: Set Up a Development Environment
order: 2

key: development environment
parent: contribute to eslint
title: Set up a Development Environment
order: 6
---

ESLint has a very lightweight development environment that makes updating code fast and easy. This is a step-by-step guide to setting up a local development environment that will let you contribute back to the project.
Expand Down
14 changes: 7 additions & 7 deletions docs/src/contribute/governance.md
Expand Up @@ -2,9 +2,9 @@
title: Governance
eleventyNavigation:
key: governance
parent: maintainer guide
parent: contribute to eslint
title: Governance
order: 4
order: 10

---

Expand Down Expand Up @@ -36,8 +36,8 @@ Website Team Members are community members who have shown that they are committe
* Are expected to delete their public branches when they are no longer necessary.
* Must submit pull requests for all changes.
* Have their work reviewed by Reviewers and TSC members before acceptance into the repository.
* May label and close website-related issues (see [Managing Issues](../maintain/manage-issues))
* May merge some pull requests (see [Managing Pull Requests](../maintain/review-pull-requests))
* May label and close website-related issues (see [Manage Issues](../maintain/manage-issues))
* May merge some pull requests (see [Review Pull Requests](../maintain/review-pull-requests))

To become a Website Team Member:

Expand All @@ -59,8 +59,8 @@ Committers:
* Are expected to delete their public branches when they are no longer necessary.
* Must submit pull requests for all changes.
* Have their work reviewed by TSC members before acceptance into the repository.
* May label and close issues (see [Managing Issues](../maintain/manage-issues))
* May merge some pull requests (see [Managing Pull Requests](../maintain/review-pull-requests))
* May label and close issues (see [Manage Issues](../maintain/manage-issues))
* May merge some pull requests (see [Review Pull Requests](../maintain/review-pull-requests))

To become a Committer:

Expand Down Expand Up @@ -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 documentation](../maintain/) 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
Expand Down
48 changes: 33 additions & 15 deletions docs/src/contribute/index.md
@@ -1,11 +1,9 @@
---
title: Contributing
title: Contribute to ESLint
eleventyNavigation:
key: contributing
parent: developer guide
title: Contributing
order: 10

key: contribute to eslint
title: Contribute to ESLint
order: 3
---

One of the great things about open source projects is that anyone can contribute in any number of meaningful ways. ESLint couldn't exist without the help of the many contributors it's had since the project began, and we want you to feel like you can contribute and make a difference as well.
Expand All @@ -16,34 +14,54 @@ This guide is intended for anyone who wants to contribute to an ESLint project.

ESLint welcomes contributions from everyone and adheres to the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct). We kindly request that you read over our code of conduct before contributing.

## [Bug Reporting](report-bugs)
## [Report Bugs](report-bugs)

Think you found a problem? We'd love to hear about it. This section explains how to submit a bug, the type of information we need to properly verify it, and the overall process.

## Proposing a [New Rule](propose-new-rule)
## [Propose a New Rule](propose-new-rule)

We get a lot of proposals for new rules in ESLint. This section explains how we determine which rules are accepted and what information you should provide to help us evaluate your proposal.

## Proposing a [Rule Change](propose-rule-change)
## [Propose a Rule Change](propose-rule-change)

Want to make a change to an existing rule? This section explains the process and how we evaluate such proposals.

## Requesting a [Change](request-change)
## [Request a Change](request-change)

If you'd like to request a change other than a bug fix or new rule, this section explains that process.

## Reporting a security vulnerability
## [Architecture](architecture)

Learn about the architecture of the ESLint project.

## [Get the Source Code](source-code)

Before you can get started developing ESLint, you'll need to get a copy of the ESLint source code. This section explains how to do that and a little about the source code structure.

## [Set up a Development Environment](development-environment)

Developing for ESLint is a bit different than running it on the command line. This section shows you how to set up a development environment and get you ready to write code.

To report a security vulnerability in ESLint, please use our [HackerOne program](https://hackerone.com/eslint).
## [Run the Tests](tests)

## [Working on Issues](work-on-issue)
There are a lot of unit tests included with ESLint to make sure that we're keeping on top of code quality. This section explains how to run the unit tests.

## [Work on Issues](work-on-issue)

Have some extra time and want to contribute? This section talks about the process of working on issues.

## Submitting a [Pull Request](pull-requests)
## [Submit a Pull Request](pull-requests)

We're always looking for contributions from the community. This section explains the requirements for pull requests and the process of contributing code.

## Signing the CLA
## [Governance](governance)

Describes the governance policy for ESLint, including the rights and privileges of individuals inside the project.

## Report a Security Vulnerability

To report a security vulnerability in ESLint, please use our [create an advisory](https://github.com/eslint/eslint/security/advisories/new).

## Sign the CLA

In order to submit code or documentation to an ESLint project, you will need to electronically sign our Contributor License Agreement. The CLA is the commonly used Apache-style template, and is you giving us permission to use your contribution. You only need to sign the CLA once for any OpenJS Foundation projects that use EasyCLA. You will be asked to sign the CLA in the first pull request you open.
10 changes: 7 additions & 3 deletions docs/src/contribute/propose-new-rule.md
@@ -1,6 +1,10 @@
---
title: New Rules

title: Propose a New Rule
eleventyNavigation:
key: propose rule
parent: contribute to eslint
title: Propose a New Rule
order: 2
---

ESLint is all about rules. For most of the project's lifetime, we've had over 200 rules, and that list continues to grow. However, we can't just accept any proposed rule because all rules need to work cohesively together. As such, we have some guidelines around which rules can be part of the ESLint core and which are better off as custom rules and plugins.
Expand Down Expand Up @@ -42,4 +46,4 @@ The ESLint team doesn't implement new rules that are suggested by users because

## Alternative: Creating Your Own Rules

Remember that ESLint is completely pluggable, which means you can create your own rules and distribute them using plugins. We did this on purpose because we don't want to be the gatekeepers for all possible rules. Even if we don't accept a rule into the core, that doesn't mean you can't have the exact rule that you want. See the [working with rules](../extend/custom-rules) and [working with plugins](../extend/plugins) documentation for more information.
Remember that ESLint is completely pluggable, which means you can create your own rules and distribute them using plugins. We did this on purpose because we don't want to be the gatekeepers for all possible rules. Even if we don't accept a rule into the core, that doesn't mean you can't have the exact rule that you want. See the [Custom Rules](../extend/custom-rules) and [Create Plugins](../extend/plugins) documentation for more information.
8 changes: 6 additions & 2 deletions docs/src/contribute/propose-rule-change.md
@@ -1,6 +1,10 @@
---
title: Rule Changes

title: Propose a Rule Change
eleventyNavigation:
key: propose rule change
parent: contribute to eslint
title: Propose a Rule Change
order: 3
---

Occasionally, a core ESLint rule needs to be changed. This is not necessarily a bug, but rather, an enhancement that makes a rule more configurable. In those situations, we will consider making changes to rules.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/pull-requests.md
@@ -1,6 +1,10 @@
---
title: Pull Requests

title: Submit a Pull Request
eleventyNavigation:
key: submit pull request
parent: contribute to eslint
title: Submit a Pull Request
order: 9
---

If you want to contribute to an ESLint repo, please use a GitHub pull request. This is the fastest way for us to evaluate your code and to merge it into the code base. Please don't file an issue with snippets of code. Doing so means that we need to manually merge the changes in and update any appropriate tests. That decreases the likelihood that your code is going to get included in a timely manner. Please use pull requests.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/report-bugs.md
@@ -1,6 +1,10 @@
---
title: Reporting Bugs

title: Report Bugs
eleventyNavigation:
key: report bugs
parent: contribute to eslint
title: Report Bugs
order: 1
---

If you think you've found a bug in ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new/choose) or a [pull request](pull-requests) on GitHub.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/request-change.md
@@ -1,6 +1,10 @@
---
title: Change Requests

title: Request a Change
eleventyNavigation:
key: request change
parent: contribute to eslint
title: Request a Change
order: 4
---

If you'd like to request a change to ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new/choose) on GitHub. Be sure to include the following information:
Expand Down
11 changes: 5 additions & 6 deletions docs/src/contribute/source-code.md
@@ -1,11 +1,10 @@
---
title: Source Code
title: Get the Source Code
eleventyNavigation:
key: getting the source code
parent: developer guide
title: Getting the Source Code
order: 1

key: get the source code
parent: contribute to eslint
title: Get the Source Code
order: 5
---

ESLint is hosted at [GitHub](https://github.com/eslint/eslint) and uses [Git](https://git-scm.com/) for source control. In order to obtain the source code, you must first install Git on your system. Instructions for installing and setting up Git can be found at <https://help.github.com/articles/set-up-git/>.
Expand Down
9 changes: 4 additions & 5 deletions docs/src/contribute/tests.md
@@ -1,11 +1,10 @@
---
title: Unit Tests
title: Run the Tests
eleventyNavigation:
key: run the tests
parent: developer guide
key: run tests
parent: contribute to eslint
title: Run the Tests
order: 3

order: 7
---

Most parts of ESLint have unit tests associated with them. Unit tests are written using [Mocha](https://mochajs.org/) and are required when making contributions to ESLint. You'll find all of the unit tests in the `tests` directory.
Expand Down
12 changes: 8 additions & 4 deletions docs/src/contribute/work-on-issue.md
@@ -1,16 +1,20 @@
---
title: Working on Issues

title: Work on Issues
eleventyNavigation:
key: work on issues
parent: contribute to eslint
title: Work on Issues
order: 8
---

Our public [issues tracker](https://github.com/eslint/eslint/issues) lists all of the things we plan on doing as well as suggestions from the community. Before starting to work on an issue, be sure you read through the rest of this page.

## Issue Labels

We use labels to indicate the status of issues. The most complete documentation on the labels is found in the [Maintainer Guide](../maintain/manage-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 documentation](../maintain/manage-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:

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](../maintain/manage-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 [Maintain ESLint](../maintain/manage-issues#types-of-issues).
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.
Expand Down
12 changes: 6 additions & 6 deletions docs/src/extend/custom-formatters.md
@@ -1,10 +1,10 @@
---
title: Working with Custom Formatters
title: Custom Formatters
eleventyNavigation:
key: working with custom formatters
parent: developer guide
title: Working with Custom Formatters
order: 6
key: custom formatters
parent: extend eslint
title: Custom Formatters
order: 3

---

Expand Down Expand Up @@ -132,7 +132,7 @@ The formatter function receives an object as the second argument. The object has
* `cwd` ... The current working directory. This value comes from the `cwd` constructor option of the [ESLint](../integrate/nodejs-api#-new-eslintoptions) class.
* `maxWarningsExceeded` (optional): If `--max-warnings` was set and the number of warnings exceeded the limit, this property's value will be an object containing two properties: `maxWarnings`, the value of the `--max-warnings` option, and `foundWarnings`, the number of lint warnings.
* `rulesMeta` ... The `meta` property values of rules. See the [Working with Rules](custom-rules) page for more information about rules.
* `rulesMeta` ... The `meta` property values of rules. See the [Custom Rules](custom-rules) page for more information about rules.
For example, here's what the object would look like if one rule, `no-extra-semi`, had been run:
Expand Down
10 changes: 5 additions & 5 deletions docs/src/extend/custom-parsers.md
@@ -1,10 +1,10 @@
---
title: Working with Custom Parsers
title: Custom Parsers
eleventyNavigation:
key: working with custom parsers
parent: developer guide
title: Working with Custom Parsers
order: 7
key: custom parsers
parent: extend eslint
title: Custom Parsers
order: 4

---

Expand Down
10 changes: 5 additions & 5 deletions docs/src/extend/custom-rules.md
@@ -1,10 +1,10 @@
---
title: Working with Rules
title: Custom Rules
eleventyNavigation:
key: working with rules
parent: developer guide
title: Working with Rules
order: 4
key: custom rules
parent: extend eslint
title: Custom Rules
order: 2

---

Expand Down

0 comments on commit ed60afd

Please sign in to comment.