Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ed60afd

Browse files
bpmutternzakasmdjermanovic
authored
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 <[email protected]> * move up get src code page * Update docs/src/contribute/index.md Co-authored-by: Milos Djermanovic <[email protected]> * Apply suggestions from code review Co-authored-by: Milos Djermanovic <[email protected]> * implement md feedback --------- Co-authored-by: Nicholas C. Zakas <[email protected]> Co-authored-by: Milos Djermanovic <[email protected]>
1 parent 333c712 commit ed60afd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+254
-214
lines changed

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ This project adheres to the [Open JS Foundation Code of Conduct](https://eslint.
1010

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

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

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

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
# ESLint
1111

1212
[Website](https://eslint.org) |
13-
[Configuring](https://eslint.org/docs/latest/use/configure) |
13+
[Configure ESLint](https://eslint.org/docs/latest/use/configure) |
1414
[Rules](https://eslint.org/docs/rules/) |
15-
[Contributing](https://eslint.org/docs/latest/contribute) |
16-
[Reporting Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
15+
[Contribute to ESLint](https://eslint.org/docs/latest/contribute) |
16+
[Report Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
1717
[Code of Conduct](https://eslint.org/conduct) |
1818
[Twitter](https://twitter.com/geteslint) |
1919
[Mailing List](https://groups.google.com/group/eslint) |

‎docs/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,4 @@
5454
"node": ">=14.0.0"
5555
}
5656
}
57+

‎docs/src/contribute/architecture/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Architecture
33
eleventyNavigation:
44
key: architecture
5-
parent: developer guide
5+
parent: contribute to eslint
66
title: Architecture
7-
order: 1
7+
order: 5
88
---
99

1010
:::img-container

‎docs/src/contribute/development-environment.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: Development Environment
2+
title: Set up a Development Environment
33
eleventyNavigation:
4-
key: set up a development environment
5-
parent: developer guide
6-
title: Set Up a Development Environment
7-
order: 2
8-
4+
key: development environment
5+
parent: contribute to eslint
6+
title: Set up a Development Environment
7+
order: 6
98
---
109

1110
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.

‎docs/src/contribute/governance.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Governance
33
eleventyNavigation:
44
key: governance
5-
parent: maintainer guide
5+
parent: contribute to eslint
66
title: Governance
7-
order: 4
7+
order: 10
88

99
---
1010

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

4242
To become a Website Team Member:
4343

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

6565
To become a Committer:
6666

@@ -143,7 +143,7 @@ A Reviewer is invited to become a TSC member by existing TSC members. A nominati
143143

144144
1. Add the GitHub user to the "ESLint TSC" GitHub team
145145
1. Set the GitHub user to be have the "Owner" role for the ESLint organization
146-
1. Send a welcome email with a link to the [maintainer guide](./) and instructions for npm 2FA.
146+
1. Send a welcome email with a link to the [Maintain ESLint documentation](../maintain/) and instructions for npm 2FA.
147147
1. Invite to the Discord TSC channel
148148
1. Make the TSC member an admin on the ESLint team mailing list
149149
1. Add the TSC member to the recurring TSC meeting event on Google Calendar

‎docs/src/contribute/index.md‎

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
title: Contributing
2+
title: Contribute to ESLint
33
eleventyNavigation:
4-
key: contributing
5-
parent: developer guide
6-
title: Contributing
7-
order: 10
8-
4+
key: contribute to eslint
5+
title: Contribute to ESLint
6+
order: 3
97
---
108

119
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.
@@ -16,34 +14,54 @@ This guide is intended for anyone who wants to contribute to an ESLint project.
1614

1715
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.
1816

19-
## [Bug Reporting](report-bugs)
17+
## [Report Bugs](report-bugs)
2018

2119
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.
2220

23-
## Proposing a [New Rule](propose-new-rule)
21+
## [Propose a New Rule](propose-new-rule)
2422

2523
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.
2624

27-
## Proposing a [Rule Change](propose-rule-change)
25+
## [Propose a Rule Change](propose-rule-change)
2826

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

31-
## Requesting a [Change](request-change)
29+
## [Request a Change](request-change)
3230

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

35-
## Reporting a security vulnerability
33+
## [Architecture](architecture)
34+
35+
Learn about the architecture of the ESLint project.
36+
37+
## [Get the Source Code](source-code)
38+
39+
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.
40+
41+
## [Set up a Development Environment](development-environment)
42+
43+
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.
3644

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

39-
## [Working on Issues](work-on-issue)
47+
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.
48+
49+
## [Work on Issues](work-on-issue)
4050

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

43-
## Submitting a [Pull Request](pull-requests)
53+
## [Submit a Pull Request](pull-requests)
4454

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

47-
## Signing the CLA
57+
## [Governance](governance)
58+
59+
Describes the governance policy for ESLint, including the rights and privileges of individuals inside the project.
60+
61+
## Report a Security Vulnerability
62+
63+
To report a security vulnerability in ESLint, please use our [create an advisory](https://github.com/eslint/eslint/security/advisories/new).
64+
65+
## Sign the CLA
4866

4967
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.

‎docs/src/contribute/propose-new-rule.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
title: New Rules
3-
2+
title: Propose a New Rule
3+
eleventyNavigation:
4+
key: propose rule
5+
parent: contribute to eslint
6+
title: Propose a New Rule
7+
order: 2
48
---
59

610
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.
@@ -42,4 +46,4 @@ The ESLint team doesn't implement new rules that are suggested by users because
4246

4347
## Alternative: Creating Your Own Rules
4448

45-
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.
49+
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.

‎docs/src/contribute/propose-rule-change.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
title: Rule Changes
3-
2+
title: Propose a Rule Change
3+
eleventyNavigation:
4+
key: propose rule change
5+
parent: contribute to eslint
6+
title: Propose a Rule Change
7+
order: 3
48
---
59

610
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.

‎docs/src/contribute/pull-requests.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
title: Pull Requests
3-
2+
title: Submit a Pull Request
3+
eleventyNavigation:
4+
key: submit pull request
5+
parent: contribute to eslint
6+
title: Submit a Pull Request
7+
order: 9
48
---
59

610
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.

0 commit comments

Comments
 (0)