Skip to content
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

docs: IA Update page URL move #16665

Merged
merged 41 commits into from Jan 15, 2023
Merged
Show file tree
Hide file tree
Changes from 36 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
f4d4e08
docs: initial IA move
bpmutter Dec 15, 2022
939605e
initial path rename
bpmutter Dec 15, 2022
725927f
Second pass
bpmutter Dec 15, 2022
9bf5924
Fix /use/ links
bpmutter Dec 15, 2022
e9c650d
allow crawling
bpmutter Dec 15, 2022
7f6eba4
trigger deploy
bpmutter Dec 15, 2022
5b80404
Additional fixes
bpmutter Dec 15, 2022
68e78a8
Remove todo
bpmutter Dec 16, 2022
a1064de
more link fixes
bpmutter Dec 16, 2022
281fecc
Fix link
bpmutter Dec 16, 2022
8d95d71
fix more broken links
bpmutter Dec 16, 2022
e7a53b5
fix more broken links
bpmutter Dec 16, 2022
aeedea4
remove noindex
bpmutter Dec 17, 2022
b8823fb
Fix broken link
bpmutter Dec 17, 2022
3c6b810
fix broken link
bpmutter Dec 17, 2022
4f652fc
remove unused files
bpmutter Dec 21, 2022
7b8265f
Change links outside of docs so no redirects
bpmutter Dec 21, 2022
29bb654
undo mistake
bpmutter Dec 21, 2022
e0cb116
Apply suggestions from code review
bpmutter Dec 28, 2022
7d15fdd
remove empty file
bpmutter Dec 28, 2022
7214e05
integrate getting started changes
bpmutter Dec 28, 2022
997dee3
add files to delete
bpmutter Dec 28, 2022
b3259eb
remove unwanted files
bpmutter Dec 28, 2022
4ab7807
move nodejs-api to integrate section && update links
bpmutter Dec 28, 2022
31e1d74
move code-path-analysis to extend section && update links
bpmutter Dec 28, 2022
a6e386b
Apply suggestions from code review
bpmutter Dec 28, 2022
a2f90d2
Update docs/src/use/configure/configuration-files.md
bpmutter Dec 28, 2022
218f749
fix migrating link
bpmutter Dec 28, 2022
0e9de7a
fix additional broken link
bpmutter Dec 28, 2022
d98e2ac
ignore-code -> ignore
bpmutter Dec 28, 2022
c804dff
unit-tests -> tests
bpmutter Dec 28, 2022
208321b
manage-pull-requests -> review-pull-requests
bpmutter Dec 28, 2022
e413ce8
migrating-to-8.0.0 -> migrate-to-8.0.0
bpmutter Dec 29, 2022
fb6b0f4
move governance to contribute
bpmutter Dec 29, 2022
37d1076
Apply suggestions from code review
bpmutter Jan 2, 2023
1097ab8
fix broken link
bpmutter Jan 2, 2023
31b938a
Update docs/src/use/migrating-to-5.0.0.md
bpmutter Jan 5, 2023
64715ce
add /latest/ to absolute URL paths
bpmutter Jan 5, 2023
53f6ea9
remove /latest/ from rules link
bpmutter Jan 5, 2023
869a5c6
Additional fixes
bpmutter Jan 6, 2023
3e50f22
Revert changes nec for link checking
bpmutter Jan 7, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -31,7 +31,7 @@
<!--
Please ensure your pull request is ready:

- Read the pull request guide (https://eslint.org/docs/developer-guide/contributing/pull-requests)
- Read the pull request guide (https://eslint.org/docs/contribute/pull-requests)
bpmutter marked this conversation as resolved.
Show resolved Hide resolved
- Include tests for this change
- Update documentation for this change (if appropriate)
-->
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Expand Up @@ -10,18 +10,18 @@ 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/developer-guide/contributing/reporting-bugs)
* [Propose a New Rule](https://eslint.org/docs/developer-guide/contributing/new-rules)
* [Proposing a Rule Change](https://eslint.org/docs/developer-guide/contributing/rule-changes)
* [Request a Change](https://eslint.org/docs/developer-guide/contributing/changes)
* [Bug Report](https://eslint.org/docs/contribute/report-bugs)
* [Propose a New Rule](https://eslint.org/docs/contribute/propose-new-rule)
* [Proposing a Rule Change](https://eslint.org/docs/contribute/propose-rule-change)
* [Request a Change](https://eslint.org/docs/contribute/request-change)

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

## Contributing Code

In order to submit code or documentation to an ESLint project, you’ll be asked to sign our CLA when you send your first pull request. (Read more about the Open JS Foundation CLA process at <https://cla.openjsf.org/>.) Also, please read over the [Pull Request Guidelines](https://eslint.org/docs/developer-guide/contributing/pull-requests).
In order to submit code or documentation to an ESLint project, you’ll be asked to sign our CLA when you send your first pull request. (Read more about the Open JS Foundation CLA process at <https://cla.openjsf.org/>.) Also, please read over the [Pull Request Guidelines](https://eslint.org/docs/contribute/pull-requests).
bpmutter marked this conversation as resolved.
Show resolved Hide resolved

## Full Documentation

Our full contribution guidelines can be found at:
<https://eslint.org/docs/developer-guide/contributing/>
<https://eslint.org/docs/contribute/>
bpmutter marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion Makefile.js
Expand Up @@ -167,7 +167,7 @@ function generateBlogPost(releaseInfo, prereleaseMajorVersion) {
*/
function generateFormatterExamples(formatterInfo) {
const output = ejs.render(cat("./templates/formatter-examples.md.ejs"), formatterInfo);
const outputDir = path.join(DOCS_SRC_DIR, "user-guide/formatters/"),
const outputDir = path.join(DOCS_SRC_DIR, "use/formatters/"),
filename = path.join(outputDir, "index.md"),
htmlFilename = path.join(outputDir, "html-formatter-example.html");

Expand Down
24 changes: 12 additions & 12 deletions README.md
Expand Up @@ -10,10 +10,10 @@
# ESLint

[Website](https://eslint.org) |
[Configuring](https://eslint.org/docs/user-guide/configuring) |
[Configuring](https://eslint.org/docs/use/configure) |
[Rules](https://eslint.org/docs/rules/) |
[Contributing](https://eslint.org/docs/developer-guide/contributing) |
[Reporting Bugs](https://eslint.org/docs/developer-guide/contributing/reporting-bugs) |
[Contributing](https://eslint.org/docs/contribute) |
[Reporting Bugs](https://eslint.org/docs/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 Expand Up @@ -76,7 +76,7 @@ The names `"semi"` and `"quotes"` are the names of [rules](https://eslint.org/do
* `"warn"` or `1` - turn the rule on as a warning (doesn't affect exit code)
* `"error"` or `2` - turn the rule on as an error (exit code will be 1)

The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see the [configuration docs](https://eslint.org/docs/user-guide/configuring)).
The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see the [configuration docs](https://eslint.org/docs/use/configure)).

## Code of Conduct

Expand All @@ -86,18 +86,18 @@ ESLint adheres to the [JS Foundation Code of Conduct](https://eslint.org/conduct

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

* [Bug Report](https://eslint.org/docs/developer-guide/contributing/reporting-bugs)
* [Propose a New Rule](https://eslint.org/docs/developer-guide/contributing/new-rules)
* [Proposing a Rule Change](https://eslint.org/docs/developer-guide/contributing/rule-changes)
* [Request a Change](https://eslint.org/docs/developer-guide/contributing/changes)
* [Bug Report](https://eslint.org/docs/contribute/report-bugs)
* [Propose a New Rule](https://eslint.org/docs/contribute/propose-new-rule)
* [Proposing a Rule Change](https://eslint.org/docs/contribute/propose-rule-change)
* [Request a Change](https://eslint.org/docs/contribute/request-change)

## Frequently Asked Questions

### I'm using JSCS, should I migrate to ESLint?

Yes. [JSCS has reached end of life](https://eslint.org/blog/2016/07/jscs-end-of-life) and is no longer supported.

We have prepared a [migration guide](https://eslint.org/docs/user-guide/migrating-from-jscs) to help you convert your JSCS settings to an ESLint configuration.
We have prepared a [migration guide](https://eslint.org/docs/use/migrating-from-jscs) to help you convert your JSCS settings to an ESLint configuration.

We are now at or near 100% compatibility with JSCS. If you try ESLint and believe we are not yet compatible with a JSCS rule/configuration, please create an issue (mentioning that it is a JSCS compatibility issue) and we will evaluate it as per our normal process.

Expand All @@ -113,19 +113,19 @@ No, ESLint does both traditional linting (looking for problematic patterns) and

### Does ESLint support JSX?

Yes, ESLint natively supports parsing JSX syntax (this must be enabled in [configuration](https://eslint.org/docs/user-guide/configuring)). Please note that supporting JSX syntax *is not* the same as supporting React. React applies specific semantics to JSX syntax that ESLint doesn't recognize. We recommend using [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) if you are using React and want React semantics.
Yes, ESLint natively supports parsing JSX syntax (this must be enabled in [configuration](https://eslint.org/docs/use/configure)). Please note that supporting JSX syntax *is not* the same as supporting React. React applies specific semantics to JSX syntax that ESLint doesn't recognize. We recommend using [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) if you are using React and want React semantics.

### What ECMAScript versions does ESLint support?

ESLint has full support for ECMAScript 3, 5 (default), 2015, 2016, 2017, 2018, 2019, 2020, 2021 and 2022. You can set your desired ECMAScript syntax (and other settings, like global variables or your target environments) through [configuration](https://eslint.org/docs/user-guide/configuring).
ESLint has full support for ECMAScript 3, 5 (default), 2015, 2016, 2017, 2018, 2019, 2020, 2021 and 2022. You can set your desired ECMAScript syntax (and other settings, like global variables or your target environments) through [configuration](https://eslint.org/docs/use/configure).

### What about experimental features?

ESLint's parser only officially supports the latest final ECMAScript standard. We will make changes to core rules in order to avoid crashes on stage 3 ECMAScript syntax proposals (as long as they are implemented using the correct experimental ESTree syntax). We may make changes to core rules to better work with language extensions (such as JSX, Flow, and TypeScript) on a case-by-case basis.

In other cases (including if rules need to warn on more or fewer cases due to new syntax, rather than just not crashing), we recommend you use other parsers and/or rule plugins. If you are using Babel, you can use [@babel/eslint-parser](https://www.npmjs.com/package/@babel/eslint-parser) and [@babel/eslint-plugin](https://www.npmjs.com/package/@babel/eslint-plugin) to use any option available in Babel.

Once a language feature has been adopted into the ECMAScript standard (stage 4 according to the [TC39 process](https://tc39.github.io/process-document/)), we will accept issues and pull requests related to the new feature, subject to our [contributing guidelines](https://eslint.org/docs/developer-guide/contributing). Until then, please use the appropriate parser and plugin(s) for your experimental feature.
Once a language feature has been adopted into the ECMAScript standard (stage 4 according to the [TC39 process](https://tc39.github.io/process-document/)), we will accept issues and pull requests related to the new feature, subject to our [contributing guidelines](https://eslint.org/docs/contribute). Until then, please use the appropriate parser and plugin(s) for your experimental feature.

### Where to ask for help?

Expand Down
4 changes: 2 additions & 2 deletions conf/rule-type-list.json
Expand Up @@ -6,12 +6,12 @@
],
"deprecated": {
"name": "Deprecated",
"description": "These rules have been deprecated in accordance with the <a href=\"/docs/user-guide/rule-deprecation\">deprecation policy</a>, and replaced by newer rules:",
"description": "These rules have been deprecated in accordance with the <a href=\"/docs/use/rule-deprecation\">deprecation policy</a>, and replaced by newer rules:",
mdjermanovic marked this conversation as resolved.
Show resolved Hide resolved
"rules": []
},
"removed": {
"name": "Removed",
"description": "These rules from older versions of ESLint (before the <a href=\"/docs/user-guide/rule-deprecation\">deprecation policy</a> existed) have been replaced by newer rules:",
"description": "These rules from older versions of ESLint (before the <a href=\"/docs/use/rule-deprecation\">deprecation policy</a> existed) have been replaced by newer rules:",
mdjermanovic marked this conversation as resolved.
Show resolved Hide resolved
"rules": [
{ "removed": "generator-star", "replacedBy": ["generator-star-spacing"] },
{ "removed": "global-strict", "replacedBy": ["strict"] },
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
Expand Up @@ -54,3 +54,4 @@
"node": ">=14.0.0"
}
}

10 changes: 4 additions & 6 deletions docs/src/_data/links.json
Expand Up @@ -8,16 +8,14 @@
"blog": "/blog",
"docs": "/docs/latest/",
"playground": "/play",
"getStarted": "/docs/latest/user-guide/getting-started",
"getStarted": "/docs/latest/use/getting-started",
"sponsors": "/sponsors",
"branding": "/branding",
"store": "https://eslint.threadless.com",
"team": "/team",

"configuring": "https://eslint.org/docs/user-guide/configuring/",
"fixProblems": "https://eslint.org/docs/user-guide/command-line-interface#fix-problems",

"configuring": "https://eslint.org/docs/use/configure/",
"fixProblems": "https://eslint.org/docs/use/command-line-interface#fix-problems",
"donate": "/donate",
"openCollective": "https://opencollective.com/eslint",
"githubSponsors": "https://github.com/sponsors/eslint"
}
}
4 changes: 2 additions & 2 deletions docs/src/_data/rules.json
Expand Up @@ -1893,7 +1893,7 @@
],
"deprecated": {
"name": "Deprecated",
"description": "These rules have been deprecated in accordance with the <a href=\"/docs/user-guide/rule-deprecation\">deprecation policy</a>, and replaced by newer rules:",
"description": "These rules have been deprecated in accordance with the <a href=\"/docs/use/rule-deprecation\">deprecation policy</a>, and replaced by newer rules:",
"rules": [
{
"name": "callback-return",
Expand Down Expand Up @@ -2009,7 +2009,7 @@
},
"removed": {
"name": "Removed",
"description": "These rules from older versions of ESLint (before the <a href=\"/docs/user-guide/rule-deprecation\">deprecation policy</a> existed) have been replaced by newer rules:",
"description": "These rules from older versions of ESLint (before the <a href=\"/docs/use/rule-deprecation\">deprecation policy</a> existed) have been replaced by newer rules:",
"rules": [
{
"removed": "generator-star",
Expand Down
6 changes: 3 additions & 3 deletions docs/src/_includes/components/rule-categories.macro.html
Expand Up @@ -5,23 +5,23 @@
<div class="rule-category">
<span class="rule-category__icon">✅ <span class="visually-hidden">Recommended</span></span>
<p class="rule-category__description">
The <code>"extends": "eslint:recommended"</code> property in a <a href="../user-guide/configuring/configuration-files#extending-configuration-files">configuration file</a> enables this rule
The <code>"extends": "eslint:recommended"</code> property in a <a href="../use/configure/configuration-files#extending-configuration-files">configuration file</a> enables this rule
</p>
</div>
{%- endif -%}
{%- if params.fixable -%}
<div class="rule-category">
<span class="rule-category__icon">🔧 <span class="visually-hidden">Fixable</span></span>
<p class="rule-category__description">
Some problems reported by this rule are automatically fixable by the <code>--fix</code> <a href="../user-guide/command-line-interface#--fix">command line</a> option
Some problems reported by this rule are automatically fixable by the <code>--fix</code> <a href="../use/command-line-interface#--fix">command line</a> option
</p>
</div>
{%- endif -%}
{%- if params.hasSuggestions == true -%}
<div class="rule-category">
<span class="rule-category__icon">💡 <span class="visually-hidden">hasSuggestions</span></span>
<p class="rule-category__description">
Some problems reported by this rule are manually fixable by editor <a href="../developer-guide/working-with-rules#providing-suggestions">suggestions</a>
Some problems reported by this rule are manually fixable by editor <a href="../extend/custom-rules#providing-suggestions">suggestions</a>
</p>
</div>
{%- endif -%}
Expand Down
2 changes: 1 addition & 1 deletion docs/src/_includes/layouts/base.html
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% if NOINDEX %}
<meta name="robots" content="noindex">
<!-- <meta name="robots" content="noindex"> -->
bpmutter marked this conversation as resolved.
Show resolved Hide resolved
{% endif %}
{% if title %}
{% set page_title = title %}
Expand Down
Expand Up @@ -71,7 +71,7 @@ The testing takes a few minutes to complete. If any tests fail, that likely mean

### Workflow

Once you have your development environment installed, you can make and submit changes to the ESLint source files. Doing this successfully requires careful adherence to our [pull-request submission workflow](contributing/pull-requests).
Once you have your development environment installed, you can make and submit changes to the ESLint source files. Doing this successfully requires careful adherence to our [pull-request submission workflow](./pull-requests).

### Build Scripts

Expand Down
Expand Up @@ -28,16 +28,16 @@ As Contributors gain experience and familiarity with the project, their profile

### Website Team Member

Website Team Members are community members who have shown that they are committed to the continued maintenance of [eslint.org](https://eslint.org/) through ongoing engagement with the community. Website Team Members are given push access to the `eslint.org` GitHub repository and must abide by the project's [Contribution Guidelines](../developer-guide/contributing/).
Website Team Members are community members who have shown that they are committed to the continued maintenance of [eslint.org](https://eslint.org/) through ongoing engagement with the community. Website Team Members are given push access to the `eslint.org` GitHub repository and must abide by the project's [Contribution Guidelines](../contribute/).

Website Team Members:

* Are expected to work on public branches of the source repository and submit pull requests from that branch to the master branch.
* 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](issues))
* May merge some pull requests (see [Managing Pull Requests](pullrequests))
* 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))

To become a Website Team Member:

Expand All @@ -51,16 +51,16 @@ It is important to recognize that membership on the website team is a privilege,

### Committers

Committers are community members who have shown that they are committed to the continued development of the project through ongoing engagement with the community. Committers are given push access to the project's GitHub repos and must abide by the project's [Contribution Guidelines](../developer-guide/contributing/).
Committers are community members who have shown that they are committed to the continued development of the project through ongoing engagement with the community. Committers are given push access to the project's GitHub repos and must abide by the project's [Contribution Guidelines](../contribute/).

Committers:

* Are expected to work on public branches of the source repository and submit pull requests from that branch to the master branch.
* 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](issues))
* May merge some pull requests (see [Managing Pull Requests](pullrequests))
* May label and close issues (see [Managing Issues](../maintain/manage-issues))
* May merge some pull requests (see [Managing Pull Requests](../maintain/review-pull-requests))

To become a Committer:

Expand Down
Expand Up @@ -16,27 +16,27 @@ 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](reporting-bugs)
## [Bug Reporting](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](new-rules)
## Proposing 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](rule-changes)
## Proposing 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](changes)
## Requesting 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

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

## [Working on Issues](working-on-issues)
## [Working on Issues](work-on-issue)

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

Expand Down
@@ -1,6 +1,6 @@
---
title: Package.json Conventions
edit_link: https://github.com/eslint/eslint/edit/main/docs/src/developer-guide/package-json-conventions.md
edit_link: https://github.com/eslint/eslint/edit/main/docs/src/contribute/package-json-conventions.md
---

The following applies to the "scripts" section of `package.json` files.
Expand Down