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

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

Open
AliMehraji opened this issue May 11, 2024 · 9 comments · May be fixed by #46320
Open

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

AliMehraji opened this issue May 11, 2024 · 9 comments · May be fixed by #46320
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/needs-information Indicates an issue needs more information in order to work on it.

Comments

@AliMehraji
Copy link
Contributor

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.

@AliMehraji AliMehraji added the kind/feature Categorizes issue or PR as related to a new feature. label May 11, 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 May 11, 2024
@k8s-ci-robot
Copy link
Contributor

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@thisisharrsh
Copy link
Contributor

/language en
/sig docs

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels May 11, 2024
@thisisharrsh
Copy link
Contributor

I would like to work on this issue.
/assign

@thisisharrsh
Copy link
Contributor

The issue is fixed here.

@AliMehraji AliMehraji changed the title A Minor Typo in Website for Replicaset in docs/concepts/workloads/controllers/reolicaset A Minor Typo in Website for Replicaset in docs/concepts/workloads/controllers/replicaset May 11, 2024
@divya-mohan0209
Copy link
Contributor

divya-mohan0209 commented May 13, 2024

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.

@divya-mohan0209 divya-mohan0209 added the triage/needs-information Indicates an issue needs more information in order to work on it. label May 13, 2024
@AliMehraji
Copy link
Contributor Author

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
Copy link
Contributor Author

AliMehraji commented May 15, 2024

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
Copy link
Contributor

@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
Copy link
Contributor

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/needs-information Indicates an issue needs more information in order to work on it.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants