Skip to content

Commit 17b65ad

Browse files
bpmutteramareshsmnzakasmdjermanovic
authored
docs: IA Update page URL move (#16665)
* docs: initial IA move * initial path rename * Second pass * Fix /use/ links * allow crawling * trigger deploy * Additional fixes * Remove todo * more link fixes * Fix link * fix more broken links * fix more broken links * remove noindex * Fix broken link * fix broken link * remove unused files * Change links outside of docs so no redirects * undo mistake * Apply suggestions from code review Co-authored-by: Amaresh S M <[email protected]> * remove empty file * integrate getting started changes * add files to delete * remove unwanted files * move nodejs-api to integrate section && update links * move code-path-analysis to extend section && update links * Apply suggestions from code review Co-authored-by: Nicholas C. Zakas <[email protected]> * Update docs/src/use/configure/configuration-files.md Co-authored-by: Nicholas C. Zakas <[email protected]> * fix migrating link * fix additional broken link * ignore-code -> ignore * unit-tests -> tests * manage-pull-requests -> review-pull-requests * migrating-to-8.0.0 -> migrate-to-8.0.0 * move governance to contribute * Apply suggestions from code review Co-authored-by: Milos Djermanovic <[email protected]> * fix broken link * Update docs/src/use/migrating-to-5.0.0.md Co-authored-by: Milos Djermanovic <[email protected]> * add /latest/ to absolute URL paths * remove /latest/ from rules link * Additional fixes * Revert changes nec for link checking Co-authored-by: Amaresh S M <[email protected]> Co-authored-by: Nicholas C. Zakas <[email protected]> Co-authored-by: Milos Djermanovic <[email protected]>
1 parent b4f8329 commit 17b65ad

File tree

85 files changed

+189
-192
lines changed

Some content is hidden

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

85 files changed

+189
-192
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<!--
3232
Please ensure your pull request is ready:
3333
34-
- Read the pull request guide (https://eslint.org/docs/developer-guide/contributing/pull-requests)
34+
- Read the pull request guide (https://eslint.org/docs/latest/contribute/pull-requests)
3535
- Include tests for this change
3636
- Update documentation for this change (if appropriate)
3737
-->

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ 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/developer-guide/contributing/reporting-bugs)
14-
* [Propose a New Rule](https://eslint.org/docs/developer-guide/contributing/new-rules)
15-
* [Proposing a Rule Change](https://eslint.org/docs/developer-guide/contributing/rule-changes)
16-
* [Request a Change](https://eslint.org/docs/developer-guide/contributing/changes)
13+
* [Bug Report](https://eslint.org/docs/latest/contribute/report-bugs)
14+
* [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)
16+
* [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).
1919

2020
## Contributing Code
2121

22-
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).
22+
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/latest/contribute/pull-requests).
2323

2424
## Full Documentation
2525

2626
Our full contribution guidelines can be found at:
27-
<https://eslint.org/docs/developer-guide/contributing/>
27+
<https://eslint.org/docs/latest/contribute/>

Makefile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ function generateBlogPost(releaseInfo, prereleaseMajorVersion) {
167167
*/
168168
function generateFormatterExamples(formatterInfo) {
169169
const output = ejs.render(cat("./templates/formatter-examples.md.ejs"), formatterInfo);
170-
const outputDir = path.join(DOCS_SRC_DIR, "user-guide/formatters/"),
170+
const outputDir = path.join(DOCS_SRC_DIR, "use/formatters/"),
171171
filename = path.join(outputDir, "index.md"),
172172
htmlFilename = path.join(outputDir, "html-formatter-example.html");
173173

README.md

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

79-
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)).
79+
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/latest/use/configure)).
8080

8181
## Code of Conduct
8282

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

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

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

9494
## Frequently Asked Questions
9595

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

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

100-
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.
100+
We have prepared a [migration guide](https://eslint.org/docs/latest/use/migrating-from-jscs) to help you convert your JSCS settings to an ESLint configuration.
101101

102102
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.
103103

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

114114
### Does ESLint support JSX?
115115

116-
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.
116+
Yes, ESLint natively supports parsing JSX syntax (this must be enabled in [configuration](https://eslint.org/docs/latest/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.
117117

118118
### What ECMAScript versions does ESLint support?
119119

120-
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).
120+
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/latest/use/configure).
121121

122122
### What about experimental features?
123123

124124
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.
125125

126126
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.
127127

128-
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.
128+
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/latest/contribute). Until then, please use the appropriate parser and plugin(s) for your experimental feature.
129129

130130
### Where to ask for help?
131131

conf/rule-type-list.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
],
77
"deprecated": {
88
"name": "Deprecated",
9-
"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:",
9+
"description": "These rules have been deprecated in accordance with the <a href=\"/docs/use/rule-deprecation\">deprecation policy</a>, and replaced by newer rules:",
1010
"rules": []
1111
},
1212
"removed": {
1313
"name": "Removed",
14-
"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:",
14+
"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:",
1515
"rules": [
1616
{ "removed": "generator-star", "replacedBy": ["generator-star-spacing"] },
1717
{ "removed": "global-strict", "replacedBy": ["strict"] },

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/_data/links.json

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,17 @@
44
"chat": "https://eslint.org/chat",
55
"group": "https://groups.google.com/group/eslint",
66
"mastodon": "https://fosstodon.org/@eslint",
7-
87
"blog": "/blog",
98
"docs": "/docs/latest/",
109
"playground": "/play",
11-
"getStarted": "/docs/latest/user-guide/getting-started",
10+
"getStarted": "/docs/latest/use/getting-started",
1211
"sponsors": "/sponsors",
1312
"branding": "/branding",
1413
"store": "https://eslint.threadless.com",
1514
"team": "/team",
16-
17-
"configuring": "https://eslint.org/docs/user-guide/configuring/",
18-
"fixProblems": "https://eslint.org/docs/user-guide/command-line-interface#fix-problems",
19-
15+
"configuring": "https://eslint.org/docs/latest/use/configure/",
16+
"fixProblems": "https://eslint.org/docs/latest/use/command-line-interface#fix-problems",
2017
"donate": "/donate",
2118
"openCollective": "https://opencollective.com/eslint",
2219
"githubSponsors": "https://github.com/sponsors/eslint"
23-
}
20+
}

docs/src/_data/rules.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1893,7 +1893,7 @@
18931893
],
18941894
"deprecated": {
18951895
"name": "Deprecated",
1896-
"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:",
1896+
"description": "These rules have been deprecated in accordance with the <a href=\"/docs/use/rule-deprecation\">deprecation policy</a>, and replaced by newer rules:",
18971897
"rules": [
18981898
{
18991899
"name": "callback-return",
@@ -2009,7 +2009,7 @@
20092009
},
20102010
"removed": {
20112011
"name": "Removed",
2012-
"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:",
2012+
"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:",
20132013
"rules": [
20142014
{
20152015
"removed": "generator-star",

docs/src/_includes/components/rule-categories.macro.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@
55
<div class="rule-category">
66
<span class="rule-category__icon"><span class="visually-hidden">Recommended</span></span>
77
<p class="rule-category__description">
8-
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
8+
The <code>"extends": "eslint:recommended"</code> property in a <a href="../use/configure/configuration-files#extending-configuration-files">configuration file</a> enables this rule
99
</p>
1010
</div>
1111
{%- endif -%}
1212
{%- if params.fixable -%}
1313
<div class="rule-category">
1414
<span class="rule-category__icon">🔧 <span class="visually-hidden">Fixable</span></span>
1515
<p class="rule-category__description">
16-
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
16+
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
1717
</p>
1818
</div>
1919
{%- endif -%}
2020
{%- if params.hasSuggestions == true -%}
2121
<div class="rule-category">
2222
<span class="rule-category__icon">💡 <span class="visually-hidden">hasSuggestions</span></span>
2323
<p class="rule-category__description">
24-
Some problems reported by this rule are manually fixable by editor <a href="../developer-guide/working-with-rules#providing-suggestions">suggestions</a>
24+
Some problems reported by this rule are manually fixable by editor <a href="../extend/custom-rules#providing-suggestions">suggestions</a>
2525
</p>
2626
</div>
2727
{%- endif -%}
File renamed without changes.

0 commit comments

Comments
 (0)