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: Update page titles, section landing pages, and side TOC #16760

Merged
merged 26 commits into from Jan 28, 2023

Conversation

bpmutter
Copy link
Contributor

@bpmutter bpmutter commented Jan 8, 2023

Note

Not ready for review til merge of IA page moves in #16365. then will rebase this PR on top of main featuring those changes.

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

As part of the docs IA update, changed the table of contents, page names, and section landing pages to reflect the updated information architecture.

Misc other notes:

Is there anything you'd like reviewers to focus on?

These issues should be completed following the work in this PR:

Resolves: #16720

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels Jan 8, 2023
@netlify
Copy link

netlify bot commented Jan 8, 2023

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit ce94f13
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/63d43cc007c63500091bbd28
😎 Deploy Preview https://deploy-preview-16760--docs-eslint.netlify.app/extend
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@amareshsm amareshsm added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jan 12, 2023
@ollie-iterators
Copy link

The pull requests about IA page moves: eslint/eslint.org#388 and #16665 have been merged

@bpmutter bpmutter marked this pull request as ready for review January 19, 2023 03:17
@bpmutter bpmutter requested a review from a team as a code owner January 19, 2023 03:17
@nzakas nzakas marked this pull request as ready for review January 20, 2023 18:08
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking pretty good, just a couple of questions.

docs/src/contribute/index.md Outdated Show resolved Hide resolved
docs/src/integrate/nodejs-api.md Show resolved Hide resolved
bpmutter and others added 2 commits January 21, 2023 12:27
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
@bpmutter bpmutter requested review from nzakas and mdjermanovic and removed request for nzakas and mdjermanovic January 21, 2023 17:35
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Copy link
Contributor

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

docs/src/contribute/governance.md Outdated Show resolved Hide resolved
docs/src/contribute/governance.md Outdated Show resolved Hide resolved
docs/src/contribute/governance.md Outdated Show resolved Hide resolved
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM pending @mdjermanovic's changes

docs/src/extend/index.md Outdated Show resolved Hide resolved
@@ -21,34 +21,26 @@ In order to work with ESLint as a developer, it's recommended that:

If that sounds like you, then continue reading to get started.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the opening section needs to be rewritten because this page is now only about extending ESLint while the current text in this section is mostly about contributing to ESLint.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed in aaad163


## Section 6: [Working with Custom Parsers](custom-parsers)
## [Custom Parsers](custom-parsers)

If you aren't going to use the default parser of ESLint, this section explains about using custom parsers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While here, I think we should update this description because the linked page explains how to create custom parsers, not how to use custom parsers.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed in aaad163

Copy link
Member

@harish-sethuraman harish-sethuraman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Great To me 🎉

Copy link
Member

@kecrily kecrily left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For other reviewer, here is a screenshot of the modified side TOC

image

I think USE ESLINT IN YOUR PROJECT is a little long.

bpmutter and others added 2 commits January 27, 2023 16:00
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
@bpmutter
Copy link
Contributor Author

@mdjermanovic accepted your suggestions and implemented changes based on your feedback in aaad163

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit ed60afd into eslint:main Jan 28, 2023
21 checks passed
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Feb 2, 2023
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.32.0` -> `8.33.0`](https://renovatebot.com/diffs/npm/eslint/8.32.0/8.33.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.33.0`](https://github.com/eslint/eslint/releases/tag/v8.33.0)

[Compare Source](eslint/eslint@v8.32.0...v8.33.0)

#### Features

-   [`2cc7954`](eslint/eslint@2cc7954) feat: add `restrictDefaultExports` option to no-restricted-exports rule ([#&#8203;16785](eslint/eslint#16785)) (Nitin Kumar)

#### Documentation

-   [`17f4be2`](eslint/eslint@17f4be2) docs: Fix examples in no-multiple-empty-lines rule ([#&#8203;16835](eslint/eslint#16835)) (jonz94)
-   [`9c7cfe3`](eslint/eslint@9c7cfe3) docs: 'Source Code' content in 'Set up Development Environment' page ([#&#8203;16780](eslint/eslint#16780)) (Ben Perlmutter)
-   [`ede5c64`](eslint/eslint@ede5c64) docs: Custom processors page ([#&#8203;16802](eslint/eslint#16802)) (Ben Perlmutter)
-   [`2620614`](eslint/eslint@2620614) docs: Code of Conduct page ([#&#8203;16781](eslint/eslint#16781)) (Ben Perlmutter)
-   [`50a8efd`](eslint/eslint@50a8efd) docs: report a sec vulnerability page ([#&#8203;16808](eslint/eslint#16808)) (Ben Perlmutter)
-   [`ed60afd`](eslint/eslint@ed60afd) docs: Update page titles, section landing pages, and side TOC ([#&#8203;16760](eslint/eslint#16760)) (Ben Perlmutter)
-   [`333c712`](eslint/eslint@333c712) docs: add background to code-path-diagrams for dark-mode ([#&#8203;16822](eslint/eslint#16822)) (Tanuj Kanti)
-   [`f5f7b9b`](eslint/eslint@f5f7b9b) docs: Update README (GitHub Actions Bot)
-   [`2aa4f5f`](eslint/eslint@2aa4f5f) docs: no-constant-condition: Add multi-comparison example ([#&#8203;16776](eslint/eslint#16776)) (Sebastian Simon)
-   [`40287db`](eslint/eslint@40287db) docs: Remove Google Group icon ([#&#8203;16779](eslint/eslint#16779)) (Nicholas C. Zakas)
-   [`ea10ca5`](eslint/eslint@ea10ca5) docs: 'a .eslint' -> 'an .eslint' for consistency ([#&#8203;16809](eslint/eslint#16809)) (Ben Perlmutter)
-   [`3be0748`](eslint/eslint@3be0748) docs: add example for nodejs lintText api ([#&#8203;16789](eslint/eslint#16789)) (Siva K)
-   [`ce4f5ff`](eslint/eslint@ce4f5ff) docs: Replace removed related rules with a valid rule ([#&#8203;16800](eslint/eslint#16800)) (Ville Saalo)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMTUuMSIsInVwZGF0ZWRJblZlciI6IjM0LjExOS4yIn0=-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1759
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@snitin315 snitin315 mentioned this pull request Feb 8, 2023
1 task
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jul 28, 2023
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jul 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Update page titles, section landing pages, and side TOC
8 participants