A Minor Typo in Website for Replicaset in docs/concepts/workloads/controllers/replicaset

kubernetes / website

Kubernetes website and documentation repo:

https://kubernetes.io

Creative Commons Attribution 4.0 International

4.49k stars 14.41k forks source link

A Minor Typo in Website for Replicaset in docs/concepts/workloads/controllers/replicaset #46319

Closed AliMehraji closed 3 months ago

AliMehraji commented 5 months ago

The Typo has no Issuee Template, so I explain here

in Replicaset Document here Non-Template Pod acquisitions:

There are two dashes -- in the fourth line of its explanation, After the template word:

The reason for this is because a ReplicaSet is not limited to owning Pods specified by its template-- it can acquire
Also Grammarly suggests writing the sentence in this way, Also it LGTM (because --> that):

The reason for this is that a ReplicaSet is not limited to owning Pods specified by its template-- it can acquire

It is not a very important Typo, but it needed to be reported and fixed in future releases.

k8s-ci-robot commented 5 months ago

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

thisisharrsh commented 5 months ago

/language en /sig docs

thisisharrsh commented 5 months ago

I would like to work on this issue. /assign

thisisharrsh commented 5 months ago

The issue is fixed here.

divya-mohan0209 commented 5 months ago

Hello @AliMehraji, Thank you for flagging this issue. This is a very minor change that does not improve the content quality in any way. I'm afraid there is not enough reason to accept triage for this. IMO, the grammar of the existing text also reads fine. Please can you advise and detail what the change you're suggesting actually improves in the document—readability, UX, grammar, or something else?

@thisisharrsh: Please refrain from working on issues until there is a triage/accepted label. As mentioned above, this doesn't significantly improve the quality of the page or simplify the content. I'll be placing a hold on the PR till we have another Wrangler chime in here or on the PR and till @AliMehraji conveys more details about how this issue improves the quality of our document.

AliMehraji commented 5 months ago

Hello @divya-mohan0209, I mentioned that this is a minor typo, to be considered in future releases to fix. Just wanted to flag it

AliMehraji commented 5 months ago

another very minor Typo is Per Example in Cluster networking types

Per example, a server or a pod can have multiple IP addresses on its interfaces, but only the IP addresses in node.status.addresses or pod.status.ips are considered for implementing the Kubernetes network model and defining the type of the cluster.

It Should be For Example.

As I mentioned all typoes are very minor, So all can be fixed in one commit/release, @divya-mohan0209 but information about what? fixing typo is not enhancing document quality? about readability, I think the suggestion of Grammarly is good, it was not easy to understand using because in the sentence I mentioned.

divya-mohan0209 commented 5 months ago

@AliMehraji : Thanks for your questions.

The answer to your question is that the dashes aren't a typo. Per the semantics of English grammar, they are known as Em dashes and serve multiple purposes. You can read more about Em dashes, En dashes, and hyphens in this entry from the Merriam Webster dictionary. In the sentence that you've flagged, it serves the purpose of a comma connecting two phrases together.

Again, regarding fixing quality of documentation/code with trivial edits, we have a policy around that as well and you can read more about it here and docs-specific guidance here. Honestly, none of the suggested changes are really improving the quality of the documentation, except the one listed in this comment and even then, it's a trivial edit.

I'm happy for other reviewers/wranglers of SIG Docs to take a look at this and triage the issue, if they think the changes made will significantly improve the quality of the documentation.

thisisharrsh commented 5 months ago

Please refrain from working on issues until there is a triage/accepted label. As mentioned above, this doesn't significantly improve the quality of the page or simplify the content.

I apologise and will keep in mind. Should I also close the PR about this issue since, in my opinion, there aren't any more significant updates to the page that enhance its quality?

aj11anuj commented 3 months ago

It looks fine either way and unless there are several minor typos on this page it's fine to leave the page as it is.

sftim commented 3 months ago

I'll close the issue. However, a full review and update to the ReplicaSet concept would still be welcome.

/close not-planned

k8s-ci-robot commented 3 months ago

@sftim: Closing this issue, marking it as "Not Planned".

In response to [this](https://github.com/kubernetes/website/issues/46319#issuecomment-2259081838): >I'll close the issue. However, a full review and update to the ReplicaSet concept would still be welcome. > >/close not-planned Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.