feat: starter CHANGELOG for docs #871
Draft
+57
−0
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR starts (belatedly) a docs repo CHANGELOG
Target publish before the major upgrade, let's include the notable impactful changes that our users need to know about
Highlight especially the updates that require actions from our users.
Add entries with links to the docs that have updates our users will need to be successful with Berkeley
Links will work after docs are live
Why keep a changelog?
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. Docs are not versioned, but with the major upgrade, let's be sure to let our users know where they can read about the high impact technical changes.
Who needs a changelog?
People do. The users of software are human beings who care about what's in the software. When the software changes, people want to know why and how.