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

Jump to bottom

docs: Static further reading links #15890

Merged
merged 5 commits into from May 20, 2022
Merged

docs: Static further reading links #15890

merged 5 commits into from May 20, 2022

Conversation

nzakas
Copy link
Member

@nzakas nzakas commented May 18, 2022

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)

Switched the further reading links to pull from a data file and added a script to generate the data file. This will improve build performance and also allow us to tweak the images used for URLs easily.

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

I'd really like to run the fetch-links.js script on precommit, but I'm not sure how to do that because the dependencies are not at the top level. Any ideas?

@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 May 18, 2022
@netlify
Copy link

netlify bot commented May 18, 2022 •
edited

✅ Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 530fed0
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/6287d4235fd8bb00093507a4
😎 Deploy Preview https://deploy-preview-15890--docs-eslint.netlify.app
📱 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.

@mdjermanovic
Copy link
Member

I'd really like to run the fetch-links.js script on precommit, but I'm not sure how to do that because the dependencies are not at the top level. Any ideas?

I think it makes sense to move the script from docs/tools to /tools, and add required dependencies to devDependencies of the root package.json.

@nzakas nzakas mentioned this pull request May 19, 2022
Closed
1 task
btmills
btmills approved these changes May 19, 2022
View reviewed changes
Copy link
Member

@btmills btmills left a comment

Choose a reason for hiding this comment

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

One small docs update for consistency with the relocated script, then LGTM.

docs/README.md Outdated Show resolved Hide resolved
@mdjermanovic
Copy link
Member

I'd really like to run the fetch-links.js script on precommit,

I tried this and the further_reading_links.json file was correctly updated. However, since no changes for that file were staged prior to running lint-staged, this change wasn't included in the commit, so the contributor should add another commit, which might be confusing.

mdjermanovic
mdjermanovic reviewed May 19, 2022
View reviewed changes
docs/.eleventy.js Outdated Show resolved Hide resolved
@nzakas
Copy link
Member Author

nzakas commented May 19, 2022

Addressed all the feedback. I'm also now running git add on the precommit hook so it seems to work quite nicely now.

@mdjermanovic mdjermanovic 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 May 20, 2022
mdjermanovic
mdjermanovic reviewed May 20, 2022
View reviewed changes
docs/README.md Outdated Show resolved Hide resolved
@nzakas @mdjermanovic
Update docs/README.md
530fed0 
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
@nzakas nzakas merged commit 050d5f4 into main May 20, 2022
@nzakas nzakas deleted the docs-links-script branch May 20, 2022 17:58
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request May 24, 2022
Update dependency eslint to v8.16.0 (#1366)
f913894 
This PR contains the following updates:

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

---

### Release Notes

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

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

[Compare Source](eslint/eslint@v8.15.0...v8.16.0)

#### Features

-   [`cab0c22`](eslint/eslint@cab0c22) feat: add Unicode flag suggestion in no-misleading-character-class ([#&#8203;15867](eslint/eslint#15867)) (Milos Djermanovic)
-   [`38ae956`](eslint/eslint@38ae956) feat: check Unicode code point escapes in no-control-regex ([#&#8203;15862](eslint/eslint#15862)) (Milos Djermanovic)
-   [`ee69cd3`](eslint/eslint@ee69cd3) feat: Update global variables ([#&#8203;15871](eslint/eslint#15871)) (Sébastien Règne)

#### Bug Fixes

-   [`3f09aab`](eslint/eslint@3f09aab) fix: function-paren-newline crash on "new new Foo();" ([#&#8203;15850](eslint/eslint#15850)) (coderaiser)

#### Documentation

-   [`050d5f4`](eslint/eslint@050d5f4) docs: Static further reading links ([#&#8203;15890](eslint/eslint#15890)) (Nicholas C. Zakas)
-   [`36287c0`](eslint/eslint@36287c0) docs: fix absolute paths in related rules shortcode to work from /docs ([#&#8203;15892](eslint/eslint#15892)) (Milos Djermanovic)
-   [`90b6990`](eslint/eslint@90b6990) docs: fix absolute links in rule macro to work from /docs ([#&#8203;15891](eslint/eslint#15891)) (Milos Djermanovic)
-   [`f437249`](eslint/eslint@f437249) docs: Adjust docs site path prefix ([#&#8203;15889](eslint/eslint#15889)) (Nicholas C. Zakas)
-   [`6e16025`](eslint/eslint@6e16025) docs: update 'Related Rules' and 'Further Reading' in remaining rules ([#&#8203;15884](eslint/eslint#15884)) (Milos Djermanovic)
-   [`1d39f69`](eslint/eslint@1d39f69) docs: remove confusing examples for no-mixed-operators ([#&#8203;15875](eslint/eslint#15875)) (Milos Djermanovic)
-   [`3071d76`](eslint/eslint@3071d76) docs: Fix some grammar issues ([#&#8203;15837](eslint/eslint#15837)) (byodian)

#### Chores

-   [`1768d0d`](eslint/eslint@1768d0d) chore: upgrade [@&#8203;eslint/eslintrc](https://github.com/eslint/eslintrc)[@&#8203;1](https://github.com/1).3.0 ([#&#8203;15903](eslint/eslint#15903)) (Milos Djermanovic)
-   [`c686e4c`](eslint/eslint@c686e4c) chore: Add deploy workflow for docs site ([#&#8203;15894](eslint/eslint#15894)) (Nicholas C. Zakas)
-   [`c7894cd`](eslint/eslint@c7894cd) chore: enable some rules from eslint-plugin-unicorn internally ([#&#8203;15878](eslint/eslint#15878)) (Bryan Mishkin)
-   [`ea65cb5`](eslint/eslint@ea65cb5) chore: upgrade eslint-plugin-eslint-plugin@^4.2.0 ([#&#8203;15882](eslint/eslint#15882)) (唯然)
-   [`cc29c69`](eslint/eslint@cc29c69) chore: Upgrade official GitHub actions to latest versions ([#&#8203;15880](eslint/eslint#15880)) (Darius Dzien)
-   [`5891c75`](eslint/eslint@5891c75) chore: Refactor rule docs format ([#&#8203;15869](eslint/eslint#15869)) (Nicholas C. Zakas)

</details>

---

### Configuration

📅 **Schedule**: 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, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1366
Reviewed-by: 6543 <6543@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
srijan-deepsource pushed a commit to DeepSourceCorp/eslint that referenced this pull request May 30, 2022
@nzakas @mdjermanovic @srijan-deepsource
docs: Static further reading links (eslint#15890)
de29276 
* docs: Static further reading links

* Move script to top level

* Address feedback

* Update docs readme

* Update docs/README.md

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

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
srijan-deepsource added a commit to DeepSourceCorp/eslint that referenced this pull request May 30, 2022
@srijan-deepsource
Revert "docs: Static further reading links (eslint#15890)"
3e53a9c 
This reverts commit de29276.
@sync-by-unito sync-by-unito bot mentioned this pull request Jun 1, 2022
Closed
@sync-by-unito sync-by-unito bot mentioned this pull request Jul 1, 2022
Closed
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Nov 17, 2022
@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 Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mdjermanovic mdjermanovic mdjermanovic left review comments

@btmills btmills btmills approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@nzakas @mdjermanovic @btmills