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

chore: add version to rules #16022

Closed

Conversation

DeepshikaS
Copy link
Contributor

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:

Reference : #16008

What changes did you make? (Give an overview)

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

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon bug ESLint is working incorrectly labels Jun 18, 2022
@netlify
Copy link

netlify bot commented Jun 18, 2022

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit cc6e22b
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62ae3c3b552dbf0008c4d26a
😎 Deploy Preview https://deploy-preview-16022--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.

@eslint-github-bot eslint-github-bot bot added the chore This change is not user-facing label Jun 18, 2022
@DeepshikaS DeepshikaS marked this pull request as ready for review June 19, 2022 18:28
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, thank you for contributing ⭐

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.

To fix the lint, can you also add Version to the know headers array?

const knownHeaders = ["Rule Details", "Options", "Environments", "Examples", "Known Limitations", "When Not To Use It", "Compatibility"];

@snitin315 snitin315 added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed bug ESLint is working incorrectly triage An ESLint team member will look at this issue soon chore This change is not user-facing labels Jun 20, 2022
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.

Thanks for working on this! But I'm not sure if we want to add this section manually to each rule as it is done in this PR, or automatically generate it from Git history as we do for the current website. so I'll ask @nzakas what the plan was.

@DeepshikaS
Copy link
Contributor Author

DeepshikaS commented Jun 20, 2022

I haven't added the versions manually. I checked the Makefile.js file and in gensite function, there's a logic to add version and releases using version.JSON. I slightly modified that logic to add the version to the new docs.

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.

Thanks for this, but we need to insert this data automatically because we won’t know the correct version for new rules until the release is made. We currently calculate the release version during release and automatically update the docs (in Makefile.JS). For the new site, we want to do the same thing and generate/update a data file with the version info.

@nzakas
Copy link
Member

nzakas commented Jun 21, 2022

Closing in favor of #16036

@nzakas nzakas closed this Jun 21, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 19, 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 Dec 19, 2022
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.

None yet

4 participants