-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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: provide docs for previous major versions #10483
Comments
Drive-by: stems from discord conversation at https://discord.com/channels/1026804805894672454/1088474511759917106/1315998130990223410 |
Fun fact, we have almost this in a kind of unofficial capacity. Each PR has a Netlify preview deploy. Example: #10416 -> https://deploy-preview-10416--typescript-eslint.netlify.app It probably wouldn't be too much work to make / augment release action(s) that, for each version:
|
I'm a very strong -1 here. It's also rare that there's enough changes in a major that you can get 90%+++ of the way with the new docs. We have discussed this in the past but decided against it expressly because it involves managing multiple deployments on netlify and it means that there are problems like out-of-date contributor/maintenance docs being visible/searchable, out of date sponsors, etc. |
I personally find that being able to easily view older versions of rule pages (including minor versions, not just previous major) is very helpful as a user when upgrading to the latest version. If this has already been firmly decided upon previously, we don't have to rehash it, but I would be happy to make a case in favor of this if it's open for discussion. |
I second kirkwaiblinger. I’m currently maintaining several projects on a legacy (ts-)eslint version because I haven’t had the time to upgrade yet. I’ve just come across an instance where the autoformatter doesn’t work as intended. I would’ve appreciated the possibility to look up the appropriate rule in the docs and change the config, which would have been a simple change, rather than invest the ”few hours of work to do a major upgrade”. |
Coming back to this: I think we should do it. User motivation: folks keep asking for it. Even several hours of work can be too much for teams on tight deadlines. Project motivation: we can be very very verbose in a "this is an old version! don't use it!" banner. I think this would be a great opportunity to showcase why you should really update:
Per #10483 (comment) I don't think it'll be a lot of work. |
Before You File a Documentation Request Please Confirm You Have Done The Following...
Suggested Changes
Provide docs for previous major versions, similar to ESLint, optionally with a banner to notify about EOL.
Affected URL(s)
https://typescript-eslint.io/rules/ and/or pages under the
Docs
tab.Additional Info
ESLint Issues/PRs
eslint/eslint#18229
eslint/eslint.org#609
The text was updated successfully, but these errors were encountered: