[docs] why can't I hold all these changelogs #7348
Merged
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
- this is significantly more useful than the tree link (IMO) because it contains more - the option to view the repo at that tag, the option to download the source code, and the standalone changelog
cee-chen
force-pushed
the
changelog-improvements
branch
from
6312ba1 to
13dae92
Compare
cee-chen
added
documentation
cee-chen
force-pushed
the
changelog-improvements
branch
from
13dae92 to
488e37a
Compare
cee-chen
force-pushed
the
changelog-improvements
branch
from
488e37a to
5d9930b
Compare
+ [UX] Add a skeleton loader - raw loader still takes a noticeable second or two for the larger years, so might as well make that behavior more intentional
cee-chen
force-pushed
the
changelog-improvements
branch
from
403e47c to
c4d4c28
Compare
- using `new Date()` will cause old versions in the future to show dates with no changelogs, which is no bueno - we should freeze/make the data static to the release
+ references to the old file/directories
- broke in the version switcher PR, not this PR
cee-chen
force-pushed
the
changelog-improvements
branch
from
c4d4c28 to
2af9047
Compare
|
Preview staging links for this PR:
|
💚 Build Succeeded
History
|
|
Yay for loading changelogs faster in the docs! And hopefully, this means there's a smaller chance we'll see the angry Github unicorn when viewing the raw changelogs! 
|
|
Bree!!!! If only you could approve my PR like old times 😆 |
tkajtoch
approved these changes
Nov 9, 2023
|
Adding a note of nuance from @kyrspl from Slack - in EUI+/the new docs site, we should forego the changelog page in favor of linking directly to our GitHub release page or to our new |
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.
Summary
addresses #6347 (apparently nothing lights a fire under my butt like seeing an issue that mildly annoys me get pinged or closed by the stale bot 🔥)
Our changelogs (over 6k lines as of this PR) have gotten so large that they take over 10 seconds to load in our docs and on GitHub. This is no way to live life, so I decided to see what other large repos were doing, and particularly was inspired by Node.js (nodejs/node#5533).
Splitting up by year appealed to me a lot (based on EUI's current weekly versioning/release strategy) rather than by majors or # of releases. So, here's what resulted:
Also while here, I updated each changelog heading with a
vprefix and updated their links to point at the release/tag rather than at the repo (more useful IMO).QA
yarn yo-changelog 1, write whatevernode -e "require('./scripts/update-changelog').manualChangelog()"CHANGELOG_2023.mdand confirm it updated correctly and removed the new upcoming changelogyarn startGeneral checklist
N/A, docs/infra only change