kubernetes / website

Kubernetes website and documentation repo:

Home Page:https://kubernetes.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cloud Controller Manager documentation links to itself

jawnsy opened this issue · comments

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

/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.

/language en

/assign

Looks like @jawnsy is already into it.

/unassign

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

Thanks @jawnsy I am currently huddling with this following PR

/assign

Fixed in #46823

/close

@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.