Skip to content
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

Promote ECK 2.16 branch to current #3149

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

naemono
Copy link
Contributor

@naemono naemono commented Dec 18, 2024

No description provided.

Signed-off-by: Michael Montgomery <[email protected]>
@naemono naemono requested a review from a team as a code owner December 18, 2024 19:22
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@naemono
Copy link
Contributor Author

naemono commented Dec 18, 2024

INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud-on-k8s/2.9/k8s-eck-permissions.html contains broken links to:
--
  | INFO:build_docs:   - en/cloud-on-k8s/current/k8s-volume-claim-templates.html#k8s_updating_the_volume_claim_settings

🚨 Error: The command exited with status 255
--
  | user command error: exit status 255

@elastic/docs-repo-owners ^^ Is the above INFO message the cause of these failures? Or something else beyond my/our control? If so, why didn't we see this in #3139 ?

@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented Dec 18, 2024

👋 @naemono it looks like the problem is that:

  • This new ID (resolves to k8s-volume-claim-templates-update) was added to the 2.16 branch in (Doc+) quickstart+KB cloud-on-k8s#8128.
  • In previous versions, there was no ID specified so it was generating an ID (k8s_updating_the_volume_claim_settings).

I'm not too familiar with the cloud repo so @kilfoyle is probably the best person to decide which solution makes most sense, but it might involve:

  • Updating the links in line 64 and line 72 to use the new ID.
  • Backport those changes all the way back to 1.7.

@naemono
Copy link
Contributor Author

naemono commented Dec 18, 2024

👋 @naemono it looks like the problem is that:

  • This new ID (resolves to k8s-volume-claim-templates-update) was added to the 2.16 branch in (Doc+) quickstart+KB cloud-on-k8s#8128.
  • In previous versions, there was no ID specified so it was generating an ID (k8s_updating_the_volume_claim_settings).

I'm not too familiar with the cloud repo so @kilfoyle is probably the best person to decide which solution makes most sense, but it might involve:

  • Updating the links in line 64 and line 72 to use the new ID.
  • Backport those changes all the way back to 1.7.

Thanks for helping me understand what the issue is @colleenmcginnis . I'm confused by something though, if I look at the 2.15 branch, the link works. Why is the docs build process trying to use an id that only exists in the 2.16 branch in the 2.15 docs (and all previous branches as well)?

@colleenmcginnis
Copy link
Contributor

Yea this is a confusing one. I think this is happening because line 64 and line 72 use hard-coded links to current in version 2.15 (and earlier), which is fine as long as 2.15 is the current version. BUT in this PR you are changing the current version to 2.16 so now those hard-coded links in 2.15 (and earlier) are trying to link to a page/section that doesn't exist in the new current (i.e. 2.16). 😵‍💫

@naemono
Copy link
Contributor Author

naemono commented Dec 18, 2024

Yea this is a confusing one. I think this is happening because line 64 and line 72 use hard-coded links to current in version 2.15 (and earlier), which is fine as long as 2.15 is the current version. BUT in this PR you are changing the current version to 2.16 so now those hard-coded links in 2.15 (and earlier) are trying to link to a page/section that doesn't exist in the new current (i.e. 2.16). 😵‍💫

OIC now... thanks a ton for that explanation. That helps me think through the correct way to fix this.

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

The build made it through the link checking stage. If the check passes after the build is complete, feel free to merge!

@naemono naemono merged commit 84c8b90 into elastic:master Dec 19, 2024
3 checks passed
@naemono naemono deleted the current-eck-2.16.0-v2 branch December 19, 2024 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants