[Proposal] Relocate and Rename Changelog to CHANGELOG.md in Flutter/Flutter Repository #149815
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
itsjustkevin
changed the title
Piinks
reviewed
Jun 6, 2024
Contributor
Piinks
left a comment
Piinks
left a comment
There was a problem hiding this comment.
Totally on board with this, couple things..
- let me land #149544 first which updates all links referencing wiki pages in flutter/flutter
- then we'll need to update any references to Hotfixes-to-the-Stable-Channel with a find and replace to point to the new file
- and update the original wiki page that currently points to where it is now
Contributor
Author
|
Thanks @Piinks I can volunteer to do some of the heavy lifting in this task once your PR has landed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TLDR: Move the changelog, currently called "hotfixes to the stable channel", to the root directory of Flutter/Flutter and rename it to CHANGELOG.md before the Q3 release cutoff.
Background
Flutter has historically kept documentation on wiki pages in the Flutter repository. Recently, we executed a large-scale migration of our wiki into a
docsfolder within flutter/flutter.Proposal
I propose relocating the current changelog, which is called "hotfixes to the stable channel", to the root directory of the Flutter/Flutter repository and renaming it to CHANGELOG.md. This change aims to improve the visibility, accessibility, and consistency of our documentation processes.
Benefits
Timeline
I would like this proposal approved or denied before the Q3 release cutoff so it may be available within the stable branch.
Note
This proposal aims to improve our workflow and documentation standards. I am open to feedback and further discussion on how we can best implement this change.