-
Notifications
You must be signed in to change notification settings - Fork 14k
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
Comments
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 The 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. |
/language en |
I would like to work on this issue. |
The issue is fixed here. |
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. |
Hello @divya-mohan0209, I mentioned that this is a minor typo, to be considered in future releases to fix. |
another very minor Typo is
It Should be 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? |
@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. |
I apologise and will keep in mind. |
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 thetemplate
word:Also Grammarly suggests writing the sentence in this way, Also it LGTM (
because
-->that
):It is not a very important Typo, but it needed to be reported and fixed in future releases.
The text was updated successfully, but these errors were encountered: