Issue with k8s.io/docs/concepts/

[ricksevans]

It seems to me the "Concepts" page should define the concept of a Cluster.
The current Concepts page just assumes the reader knows what a Cluster is.
Is a cluster a set of Pods?
Is a cluster a set of tightly coupled Pods?
Is a cluster a set of Worker Nodes (Pod Hosts)?
Is a cluster a single Master Node and it set of minion Worker Nodes directly managed by the Master?
Is a cluster a set of Master Nodes in an HA configuration plus ALL the minion Worker Nodes?
Is a cluster all the Master Nodes and Worker Nodes used to host the pods that make up an application, regardless of the physical locallity of those Nodes?
Is a cluster another name for an application?
Is a cluster another name for a web service?
Is a cluster whatever the Developer thinks it is?
Is a cluster whatever the Operator thinks it is?

[tengqm]

Is this what you are looking for?

https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-cluster

[ricksevans]

@tengqm, yes, Adding something like the two lines from that simple definition you referred to, to the Concept page would suffice.

Also the second line in the definition: "A cluster has several worker nodes and at least one master node." should be changed to something like: "A cluster has at least one worker node and at least one master node. The worker node(s) host the pods that are the components of the application. The Master node(s) manages the worker nodes and the pods in the cluster. Multiple Master nodes are used to provide a cluster with failover and high availability."

[sftim]

This looks straightforward to work on. I would tweak the existing glossary definition, then include that revised definition into the Concepts page with a Hugo shortcode:

{{< glossary_definition term_id="kube-scheduler" length="all" >}}

If you're a new contributor picking this up, have a look at Improve existing content. The easiest way to submit a pull request that changes more than one file is to use Git and a local text editor to propose changes; GitHub's web interface is too simplistic (in my opinion).

Add a comment here if you're keen to contribute but would like more advice.

/good-first-issue

[k8s-ci-robot]

@sftim:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

This looks straightforward to work on. I would tweak the existing glossary definition, then include that revised definition into the Concepts page with a Hugo shortcode:

{{< glossary_definition term_id="kube-scheduler" length="all" >}}

If you're a new contributor picking this up, have a look at Improve existing content. The easiest way to submit a pull request that changes more than one file is to use Git and a local text editor to propose changes; GitHub's web interface is too simplistic (in my opinion).

Add a comment here if you're keen to contribute but would like more advice.

/good-first-issue

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/test-infra repository.

[sftim]

The two commits in PR 14537 are similar to what I'd do to fix this issue. For this issue, it's about tweaking an existing glossary entry and then using the definition (not the tooltip) in the concept page.

[sftim]

/language en

[jhbiggs]

Hello, would like to contribute. Confirming: you'd like an addition to the current definition, and the inclusion of that definition in the concept page via Hugo shortcode.

[sftim]

@jhbiggs: what you summarized matches what I have in mind. If you'd favored a different approach, that could be OK too!

[sftim]

Done
/close

[k8s-ci-robot]

@sftim: Closing this issue.

In response to this:

Done
/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/test-infra repository.