Skip to content

Regenerate 1.24 and 1.25 archive with header #16529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

craigbox
Copy link
Contributor

Applied #16457 to release-1.25 branch and regenerated archive.

This should result in all docs pages (in all languages) having a localised header.

I would prefer it didn't touch the other pages, but we have a minified CSS file with a name that has changed.

@craigbox craigbox requested a review from a team as a code owner May 28, 2025 02:15
@istio-testing istio-testing added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 28, 2025
@craigbox
Copy link
Contributor Author

I built the archive with:

export SCRIPT_DIR=scripts
export PREV_MINOR=1.25
DRY_RUN=1 ISTIOIO_GIT_SOURCE=https://github.com/istio/istio.io.git "${SCRIPT_DIR}"/build_old_archive.sh "build-old-archive-${PREV_MINOR}.0"

1.25 was never marked as archived (compare 1.25 and 1.24.

This looks like something John did with a commit, rather than a PR, and will have to go into the new release process. /cc @dhawton

I'll build 1.24 in the meantime and send a PR to archive 1.25.

@craigbox craigbox mentioned this pull request May 28, 2025
@dhawton
Copy link
Member

dhawton commented May 28, 2025

I built the archive with:

export SCRIPT_DIR=scripts
export PREV_MINOR=1.25
DRY_RUN=1 ISTIOIO_GIT_SOURCE=https://github.com/istio/istio.io.git "${SCRIPT_DIR}"/build_old_archive.sh "build-old-archive-${PREV_MINOR}.0"

1.25 was never marked as archived (compare 1.25 and 1.24.

This looks like something John did with a commit, rather than a PR, and will have to go into the new release process. /cc @dhawton

I'll build 1.24 in the meantime and send a PR to archive 1.25.

Right, that was one of the reasons for the PR/rework of the script I did. The old process required an admin to run the script which did the commits directly to release branches and the master branch, which was always risky. With the new flow, the script should allow it to be standardized and done in a more repeatable manner by any docs maintainer.

@craigbox craigbox mentioned this pull request May 28, 2025
@craigbox
Copy link
Contributor Author

@craigbox craigbox changed the title Regenerate 1.25 archive with header Regenerate 1.24 and 1.25 archive with header May 29, 2025
@kfaseela
Copy link
Member

https://deploy-preview-16529--preliminary-istio.netlify.app/v1.24/docs/ 🎉

When I click on the "read latest", it says page requested cannot be found.

@dhawton
Copy link
Member

dhawton commented May 29, 2025

https://deploy-preview-16529--preliminary-istio.netlify.app/v1.24/docs/ 🎉

When I click on the "read latest", it says page requested cannot be found.

I see the same.. looks like the read latest link retains the /v1.24 path prefix and just appends /latest/docs.

@craigbox
Copy link
Contributor Author

Hmm, it wasn't supposed to do that.
/cc @sbegin0

@craigbox
Copy link
Contributor Author

craigbox commented May 29, 2025

OK, here's the deal.

  • build_old_archive.sh calls make archive which is archive_version.sh (run in the build container)
  • that calls build_site.sh /"${VERSION}"
  • that runs Hugo with --baseURL "$1"

The link we add is "/latest{{ .RelPermalink | safeURL }}"

Thus any link added to this page is going to be relative to /v1.24/.

Workarounds:

  • We could change the URL to start https://istio.io/latest/, which will almost certainly break another linter
    • edit: I think the linter is only going to check .md content; we use URLs in things like the language selector in the footer and they are OK
  • maybe //latest/ would work?
    • edit: testing this first
  • We could special-case /vX.XX/latest/ URLs in the netlify handler
  • ...something else?

@craigbox
Copy link
Contributor Author

Trying //latest on the v1.25 archive to see what that makes the browser do

@craigbox
Copy link
Contributor Author

craigbox commented May 29, 2025

it makes it do https://latest/docs/ 🤦

OK, next best bet is to make it redirect to preliminary.istio.io/latest/ if it's on prelim and istio.io/latest/ if it's on live, but those are thoughts for tomorrow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants