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

Cloud Controller Manager documentation links to itself #46613

Closed
jawnsy opened this issue Jun 1, 2024 · 9 comments
Closed

Cloud Controller Manager documentation links to itself #46613

jawnsy opened this issue Jun 1, 2024 · 9 comments
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@jawnsy
Copy link

jawnsy commented Jun 1, 2024

This is a Bug Report

Problem:

The documentation for Cloud Controller Manager has a link that is self-referential. The description has a link with description cloud controller manager:

that embeds cloud-specific control logic. The [cloud controller manager](/docs/concepts/architecture/cloud-controller/) lets you link your

However, this is the URL if the current page:

full_link: /docs/concepts/architecture/cloud-controller/

Proposed Solution:

Remove the link, or link it somewhere useful.

Page to Update:

https://kubernetes.io/docs/concepts/architecture/cloud-controller/

Additional information:

  • I'm not sure if this serves a purpose of boosting SEO or similar, but as a user/reader interested in this component, it wasn't helpful for me, so I want to make it more helpful :)
  • I'd also be interested in contributing a pull request for this change
@jawnsy jawnsy added the kind/bug Categorizes issue or PR as related to a bug. label Jun 1, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jun 1, 2024
@sftim
Copy link
Contributor

sftim commented Jun 1, 2024

/priority backlog
/kind cleanup
/triage accepted

If we move the full link after the <!--more-->, that should help.


We added a diagram to
https://kubernetes.io/docs/concepts/architecture/ a while back. I'd really like to see https://kubernetes.io/docs/concepts/overview/components/ simplified to just outline what each component does, enough to help a beginner, and for the detailed explanations to move into https://kubernetes.io/docs/concepts/overview/architecture/

If we do that, https://kubernetes.io/docs/concepts/overview/architecture/ is also the right place to explain the cloud controller manager, and we can reword https://kubernetes.io/docs/concepts/architecture/cloud-controller/ accordingly.

If someone has capacity to send in PRs to get us there, this bigger change is what [I think] is really needed.

@k8s-ci-robot k8s-ci-robot added priority/backlog Higher priority than priority/awaiting-more-evidence. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 1, 2024
@sftim
Copy link
Contributor

sftim commented Jun 1, 2024

/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jun 1, 2024
@afzal442
Copy link
Contributor

afzal442 commented Jun 2, 2024

/assign

@afzal442
Copy link
Contributor

afzal442 commented Jun 2, 2024

Looks like @jawnsy is already into it.

/unassign

@jawnsy
Copy link
Author

jawnsy commented Jun 4, 2024

@afzal442 Feel free to take it if you're interested! Thank you so much 😁

@afzal442
Copy link
Contributor

afzal442 commented Jun 4, 2024

Thanks @jawnsy I am currently huddling with this following PR

@ktvargo-ms
Copy link
Contributor

/assign

@sftim
Copy link
Contributor

sftim commented Jun 16, 2024

Fixed in #46823

/close

@k8s-ci-robot
Copy link
Contributor

@sftim: Closing this issue.

In response to this:

Fixed in #46823

/close

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.

hacktivist123 pushed a commit to hacktivist123/website that referenced this issue Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

5 participants