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

New rules created during prerelease cycle appear in rules list, but rule doc not available (HTTP 404) #22

Open
platinumazure opened this issue May 27, 2018 · 2 comments
Labels

Comments

@platinumazure
Copy link
Member

platinumazure commented May 27, 2018

If a rule is created during a prerelease cycle and then the prerelease script is run, the rules list is updated with the new rule but the rule's docs are not available (files are only copied into, e.g., docs/5.0.0/rules instead of docs/rules).

Presumably, the prerelease script should be more consistent and either:

  • Not include prerelease rules on the rules list (i.e., rules list and rule doc pages are from latest stable release)
  • Include prerelease rules and also copy docs to docs/rules

I lean towards the latter because rule pages will include info on what version the rule was introduced, so it should be easy to spot rules that were introduced during the prerelease.

@revolter
Copy link

And should it also display a warning that it's not a released rule yet?

platinumazure added a commit to eslint/archive-website that referenced this issue May 28, 2018
This fixes a broken link in docs/rules index. Root cause is eslint/eslint-release#22
platinumazure added a commit to eslint/archive-website that referenced this issue May 28, 2018
This fixes a broken link in docs/rules index. Root cause is eslint/eslint-release#22
@platinumazure
Copy link
Member Author

@revolter Good call, although I think that will take more work. I've created eslint/eslint#10412, which would be a prerequisite. Thanks!

In this issue, I'd rather focus on the bugfix of ensuring all rule docs are copied appropriately to docs/rules during site generation.

platinumazure added a commit to eslint/archive-website that referenced this issue May 28, 2018
* Fix: Add max-classes-per-file to main rules directory

This fixes a broken link in docs/rules index. Root cause is eslint/eslint-release#22

* Fix: Add prefer-object-spread to main rules directory

This fixes a broken link in docs/rules index. Root cause is eslint/eslint-release#22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants