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

Fixed link navigation bug #49414

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aakankshabhende
Copy link
Contributor

Description

The subsection "Update configuration via a ConfigMap in a Pod possessing a sidecar container" contains the sentence:

Please see Enabling sidecar containers to utilize this feature.

The sidecar-containers page doesn't have a subsection on enabling sidecar containers, so I navigated the link to example showing deployment having sidecar config.

Issue

Closes: #49326

Signed-off-by: aakankshabhende <[email protected]>
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language labels Jan 13, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign salaxander for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 13, 2025
Copy link

netlify bot commented Jan 13, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit f63b95a
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67853e07b342550008388ced
😎 Deploy Preview https://deploy-preview-49414--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -434,7 +434,7 @@ The above scenario can be replicated by using a [Sidecar Container](/docs/concep
as a helper container to write the HTML file.
As a Sidecar Container is conceptually an Init Container, it is guaranteed to start before the main web server container.
This ensures that the HTML file is always available when the web server is ready to serve it.
Please see [Enabling sidecar containers](/docs/concepts/workloads/pods/sidecar-containers/#enabling-sidecar-containers) to utilize this feature.
Please see [Enabling sidecar containers](/docs/concepts/workloads/pods/sidecar-containers/#sidecar-example) to utilize this feature.
Copy link
Member

Choose a reason for hiding this comment

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

Instead of linking to the example section, perhaps we could update the link text to point directly to the previous section? This might make it a bit better.

Suggested change
Please see [Enabling sidecar containers](/docs/concepts/workloads/pods/sidecar-containers/#sidecar-example) to utilize this feature.
Please see [Sidecar containers in Kubernetes](/docs/concepts/workloads/pods/sidecar-containers/#pod-sidecar-containers) to utilize this feature.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually the first line of section points to /docs/concepts/workloads/pods/sidecar-containers/ which explains what is sidecar container, I thought it would get redundant if we point to the same section again.

Copy link
Contributor Author

@aakankshabhende aakankshabhende left a comment

Choose a reason for hiding this comment

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

I meant the line 433 which explains what is sidecar container. What do you suggest? @dipesh-rawat

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updating Configuration via a ConfigMap
3 participants