kubernetes / website

Kubernetes website and documentation repo:

Home Page:https://kubernetes.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Style guide violates its own rules

alculquicondor opened this issue · comments

Problem:

The style guide asks to use direct language https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language

However, the same page has at least 4 uses of "please". There is probably a lot of similar cases throughout the documentation.

Proposed Solution:

Remove use of "please"

Page to Update:

https://kubernetes.io/docs/contribute/style/style-guide/

/priority backlog
/triage accepted
/language en
/help

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

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

In response to this:

/priority backlog
/triage accepted
/language en
/help

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.

@sftim @alculquicondor This issue is still open. IF yes can I work on it .

  • this issue is open
    look for this mark at the top of the issue: Open
  • Kubernetes is open source; anyone can contribute
    For this repository in particular you don't need permission, you just need to follow our community code of conduct.

I'll work on it since @aryasoni98 hasn't opened a PR yet.
/assign

This issue has been resolved.
/close

@network-charles: You can't close an active issue/PR unless you authored it or you are a collaborator.

In response to this:

This issue has been resolved.
/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.

Hi @alculquicondor, I’ve resolved the issue and it has been merged. You can close the issue.

/close

@sftim: Closing this issue.

In response to this:

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