Skip to content

feat: add Out-Of-Date Documentation header for archive versions #16457

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

Merged
merged 6 commits into from
May 27, 2025

Conversation

sbegin0
Copy link
Contributor

@sbegin0 sbegin0 commented May 7, 2025

Description

Added a warning header to all docs pages warning user that this version is out-of-date with an option to go to /latest

Reviewers

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@sbegin0 sbegin0 requested a review from a team as a code owner May 7, 2025 19:24
@istio-testing istio-testing added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 7, 2025
dhawton
dhawton previously requested changes May 7, 2025
Copy link
Member

@dhawton dhawton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This branch is not served on any documentation site.

@craigbox
Copy link
Contributor

craigbox commented May 8, 2025

It will be - that's the point of the exercise. We will regenerate and re-copy the archives to the current site in order to get these changes to apply.

@dhawton
Copy link
Member

dhawton commented May 8, 2025

It will be - that's the point of the exercise. We will regenerate and re-copy the archives to the current site in order to get these changes to apply.

Gotcha.. sorry.. I didn't know that was the plan.

@dhawton dhawton dismissed their stale review May 8, 2025 07:58

letting Craig run this

Copy link
Contributor

@craigbox craigbox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last fix requests left inline.

Will the lint ever pass? Don't think so, but it should never be a problem as this header is only added when building in archive mode.
The archive pages are not linted, so I think a mass update to those won't cause a problem.

Alternatively we can detect that we're in archive mode and disable link checking.

@dhawton for thoughts

@sbegin0 sbegin0 requested a review from a team as a code owner May 20, 2025 17:46
@istio-testing istio-testing added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 20, 2025
@craigbox
Copy link
Contributor

@wilsonwu @Andygol Could you guys please help with translations for

[archive_banner_text]
other = "⚠️ This documentation is for an older version (<strong>%s</strong>) and is no longer updated."

[archive_banner_link]
other = "Read the latest version."

@Andygol
Copy link
Contributor

Andygol commented May 21, 2025

[archive_banner_text]
other = "⚠️ This documentation is for an older version (<strong>%s</strong>) and is no longer updated."

[archive_banner_link]
other = "Read the latest version."

@craigbox 🇺🇦 Ukrainian translation 👇

[archive_banner_text]
other = "⚠️ Це документація для (застарілої) версії (<strong>%s</strong>), яка вже не підтримується."

[archive_banner_link]
other = "Читати останню версію."

@craigbox
Copy link
Contributor

craigbox commented May 23, 2025

@kebe7jun too
#16457 (comment)

@kebe7jun
Copy link
Member

Chinese version:

[archive_banner_text]
other = "⚠️ 此文档针对过时的版本 (<strong>%s</strong>),将不在维护和更新。"

[archive_banner_link]
other = "查看最新文档。"

@sbegin0 sbegin0 requested a review from a team as a code owner May 23, 2025 15:29
@craigbox craigbox changed the base branch from release-1.24 to master May 27, 2025 00:11
@craigbox craigbox requested a review from a team as a code owner May 27, 2025 00:11
@istio-testing istio-testing added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 27, 2025
@istio-testing
Copy link
Contributor

istio-testing commented May 27, 2025

@sbegin0: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
lint_istio.io_release-1.24 b7fb64d link true /test lint
doc.test.dualstack_istio.io 7163922 link true /test doc.test.dualstack
doc.test.multicluster_istio.io 7163922 link true /test doc.test.multicluster
doc.test.profile-none_istio.io 7163922 link true /test doc.test.profile-none
doc.test.profile-ambient_istio.io 7163922 link true /test doc.test.profile-ambient
doc.test.profile-demo_istio.io 7163922 link true /test doc.test.profile-demo
doc.test.profile-default_istio.io 7163922 link true /test doc.test.profile-default
doc.test.profile-minimal_istio.io 7163922 link true /test doc.test.profile-minimal

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@istio-testing istio-testing added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels May 27, 2025
@craigbox
Copy link
Contributor

Rebasing onto master to merge and cherrypick, and then run against the existing archives.

@craigbox craigbox added the cherrypick/release-1.26 Set this label on a PR to auto-merge it to the release-1.26 branch label May 27, 2025
@istio-testing istio-testing merged commit f83d4a8 into istio:master May 27, 2025
6 checks passed
@craigbox craigbox added cherrypick/release-1.26 Set this label on a PR to auto-merge it to the release-1.26 branch and removed cherrypick/release-1.26 Set this label on a PR to auto-merge it to the release-1.26 branch labels May 27, 2025
@istio-testing
Copy link
Contributor

In response to a cherrypick label: new pull request created: #16521

@istio istio deleted a comment from istio-testing May 27, 2025
@craigbox craigbox changed the title Added Out-Of-Date Documentation Header for v1.24 feat: add Out-Of-Date Documentation header for archive versions May 28, 2025
@craigbox craigbox added the cherrypick/release-1.25 Set this label on a PR to auto-merge it to the release-1.25 branch label May 28, 2025
@istio-testing
Copy link
Contributor

In response to a cherrypick label: new pull request created: #16527

@istio-testing
Copy link
Contributor

In response to a cherrypick label: new pull request created: #16530

@istio-testing
Copy link
Contributor

In response to a cherrypick label: new issue created for failed cherrypick: #16532

@istio-testing
Copy link
Contributor

In response to a cherrypick label: new issue created for failed cherrypick: #16533

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick/release-1.24 Set this label on a PR to auto-merge it to the release-1.24 branch cherrypick/release-1.25 Set this label on a PR to auto-merge it to the release-1.25 branch cherrypick/release-1.26 Set this label on a PR to auto-merge it to the release-1.26 branch kind/docs size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants