Drop docs versions v1.1.0, v1.2.0, v1.3.0 #82
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
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.
What's Changing
This PR is dropping the tagged sets for the three oldest GA Zed releases on the docs site.
Why
After I merged #81, the broken link checker that runs after the deployment failed because it reported several TCP timeouts and HTTP 429 errors when trying to crawl the site. The same thing happened on a re-run. This change seems to make it run clean again.
Discussion
I've been suspicious for a while that the large number of older tagged docs versions might start to become a problem. In addition to concerns about the broken link crawler, the tallness of the version selection drop-down, combined with the oldness of the releases and how unlikely it is users would need to refer to them, has indeed started to make it feel a little silly to continue publishing so many. Maybe we could stand to trim even further, but I know we have some community zync users that are a bit more conservative about running older releases they've tested heavily, so for now I'm keen to just trim back whatever's necessary to make the link checker happy again.
To delete the old versions I followed these instructions at the Docusaurus site. I then did a test build and deploy of what's in this branch to a personal staging site at https://spiffy-gnome-8f2834.netlify.app/. Using the Action in my personal broken-link-checker repo (which uses the same link checker config we use for the web site) I was able to check it without failure 5 times in a row without issue, so I think this change will get us back in business.
Assuming this all works out, going forward I'll just make another step in my release checklist to drop the oldest version at the same time I'm tagging docs for a new release and hopefully that'll keep things steady.