-
Notifications
You must be signed in to change notification settings - Fork 140
docs: split changelog to current and legacy versions #697
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've scanned through some other files to make sure that no files are missed, however I can't review this PR's files due to my GitHub constantly crashing 😂, however, it looks good to me so far.
I'm not entirely sure this change is worth it. Why should we make this change? (Additionally, this isn't the full scope of changes we should make if we are making this change). |
Because of this:
I especially noticed these while working on #695, I don't necessarily see the point in keeping them around, as they provide no information to readers.
Mind elaborating? Not quite sure what you mean. |
It would make some sense to do one of the following: seperate all changelog entries below 2.x to a new page or add a header saying these are shown for historic or legacy purposes. Additionally, migrating to 1.0 and migrating to async pages could be removed/have the same header. |
@onerandomusername I've moved the legacy changelogs to a separate page, and linked that at the bottom of the main changelog page. |
This indirectly closes or changes #347 |
@shiftinv would you please resolve conflicts? |
I'm not entirely sure this is a great idea, but I also don' really have a concrete reason why this would be a bad idea either. If anyone has any objections against this pr, or agrees with this pr, please comment react to this pr so we know what others think. |
@shiftinv would you please resolve conflicts before they grow? |
f594e72
to
5812326
Compare
I'm still on the fence about removing all 1.x and 0.x references from the documentation. However, moving the changelog would be nice, and it would be appreciated if we could implement that. Could you revert the versionchanged 1.x changes from this pr so we can get it merged? |
5812326
to
2158028
Compare
Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Summary
Unlinks the v1.0 migration page from the main index (keeping the only reference in the changelog), and moves the 0.x/1.x changelogs to a separate page.
Checklist
task lint
task pyright