Remove tarballs & Docker links for v20.2 and below #19036
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
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@mdlinville maybe this is also an offline convo but wanted to show you what i have so far to get your feedback from a tools POV in fact let me DM you to set up some time to walk through this PR maybe |
mdlinville
reviewed
Oct 22, 2024
rmloveland
force-pushed
the
20241022-DOC-11092-remove-download-links-prior-to-v20.2
branch
2 times, most recently
from
b71b6bc
to
f703a09
Compare
|
@jlinder and @celiala i believe this PR implements the "remove binaries, tarballs, and Docker links for <= v20.1" as we discussed in our meeting See the PR summary for details of how this is accomplished by adding a new variable to each block of the the rest of the edits beyond the Liquid templates and the YAML file are removing links from old release pages probably a good place to start verifying the expected behavior is the rendered previews linked from the description |
|
cc @jaiayu FYI just so you know this is in progress |
mdlinville
approved these changes
Nov 6, 2024
Yayyyy thanks for the review Matt!!!! the logic is here (and also in several other places but they're all the same basic Liquid code): it basically adds another case to the existing if-else blocks below the "is this a cloud-only release" check with another check that is basically "is this release no longer downloadable" |
mdlinville
approved these changes
Nov 6, 2024
jlinder
requested changes
Nov 11, 2024
There was a problem hiding this comment.
For the releases that are being suppressed (20.1 and before) this LGTM. But the v20.2 releases also need to have their tarballs and docker links removed as well (somehow we must have missed clearly indicating the 20.2 releases also needed to be included when we discussed this change 😕).
Fixes DOC-11092 Summary of changes: - Update releases.yml with a new boolean field - Update releases index page to stop showing downloads for versions <= v20.2 - Update individual release pages to remove download links for versions <= v20.2 How it works: When a specific release (or an entire major version's releases) should be made no longer available for download, add the following k-v pair to the YAML block for that release: is_not_downloadable: true There is now logic in the Liquid templates that build the main releases page that checks for this YAML key being set to true. If it is set to true, the releases page will no longer display links to: - Pre-built binary downloads - Docker tags - Release tarballs Instead, the table cells where such artifacts used to appear will now display the message: No longer available for download.
rmloveland
force-pushed
the
20241022-DOC-11092-remove-download-links-prior-to-v20.2
branch
from
f703a09
to
950c324
Compare
rmloveland
changed the title
Remove v20.2 tarballs and Docker links as well
|
@jlinder just updated to remove v20.2 as well, sorry about the confusion on my end, classic off-by-one error i guess PTAL! |
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.
Fixes DOC-11092
Summary of changes:
Update releases.yml with a new boolean field
Update releases index page to stop showing downloads for versions <=
v20.2
Update individual release pages to remove download links for versions
<= v20.2
How it works:
When a specific release (or an entire major version's releases) should
be made no longer available for download, add the following k-v pair to
the YAML block for that release:
There is now logic in the Liquid templates that build the main releases
page that checks for this YAML key being set to true. If it is set to
true, the releases page will no longer display links to:
Instead, the table cells where such artifacts used to appear will now
display the message: