Skip to content

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

Merged
merged 5 commits into from
Oct 17, 2022

Conversation

shiftinv
Copy link
Member

@shiftinv shiftinv commented Aug 10, 2022

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

  • If code changes were made, then they have been tested
    • I have updated the documentation to reflect the changes
    • I have formatted the code properly by running task lint
    • I have type-checked the code by running task pyright
  • This PR fixes an issue
  • This PR adds something new (e.g. new method or parameters)
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

@shiftinv shiftinv added t: documentation Improvements or additions to documentation/examples p: low Low priority s: needs review Issue/PR is awaiting reviews labels Aug 10, 2022
@shiftinv shiftinv added this to the disnake v2.6 milestone Aug 10, 2022
Copy link
Contributor

@spifory spifory left a 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.

@onerandomusername
Copy link
Member

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).

@onerandomusername onerandomusername marked this pull request as draft August 13, 2022 02:56
@onerandomusername onerandomusername changed the title docs: remove references to old versions docs: remove references to never-released disnake versions Aug 13, 2022
@shiftinv
Copy link
Member Author

I'm not entirely sure this change is worth it. Why should we make this change?

Because of this:

there technically hasn't been a non-2.x release

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.


(Additionally, this isn't the full scope of changes we should make if we are making this change).

Mind elaborating? Not quite sure what you mean.

@onerandomusername
Copy link
Member

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.

@shiftinv
Copy link
Member Author

@onerandomusername I've moved the legacy changelogs to a separate page, and linked that at the bottom of the main changelog page.
The two migration pages are linked in the v0.10.0 and v1.0.0 changelog entries, so those can't really be removed without also removing those changelogs. Since they're now only linked on the legacy changelog page, it should be fine to keep em.

@shiftinv shiftinv marked this pull request as ready for review August 17, 2022 20:22
@onerandomusername
Copy link
Member

This indirectly closes or changes #347

@onerandomusername
Copy link
Member

@shiftinv would you please resolve conflicts?

@onerandomusername
Copy link
Member

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.

@onerandomusername
Copy link
Member

@shiftinv would you please resolve conflicts before they grow?

@onerandomusername onerandomusername force-pushed the docs/remove-1.x-refs branch 2 times, most recently from f594e72 to 5812326 Compare October 1, 2022 18:29
@onerandomusername
Copy link
Member

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?

@shiftinv shiftinv force-pushed the docs/remove-1.x-refs branch from 5812326 to 2158028 Compare October 16, 2022 17:23
@shiftinv
Copy link
Member Author

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?

Done.

@onerandomusername onerandomusername changed the title docs: remove references to never-released disnake versions docs: split changelog to disnake and legacy files Oct 17, 2022
@onerandomusername onerandomusername enabled auto-merge (squash) October 17, 2022 00:25
@onerandomusername onerandomusername changed the title docs: split changelog to disnake and legacy files docs: split changelog to current and legacy versions Oct 17, 2022
@onerandomusername onerandomusername enabled auto-merge (squash) October 17, 2022 00:26
Copy link
Member

@onerandomusername onerandomusername left a comment

Choose a reason for hiding this comment

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

lgtm

@onerandomusername onerandomusername merged commit 2d4c930 into master Oct 17, 2022
@onerandomusername onerandomusername deleted the docs/remove-1.x-refs branch October 17, 2022 00:28
@onerandomusername onerandomusername removed the s: needs review Issue/PR is awaiting reviews label Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p: low Low priority t: documentation Improvements or additions to documentation/examples
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants