-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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
Clean up and implement style guidelines for “Declare Network Policy” #18980
Conversation
sharjeelaziz
commented
Feb 4, 2020
- Reworded paragraphs to reduce ambiguity.
Deploy preview for kubernetes-io-master-staging ready! Built with commit c60ddea https://deploy-preview-18980--kubernetes-io-master-staging.netlify.com |
/assign @zparnold |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is mostly just style fixes and I don't know what the style guide says, but the one addition of technical content is correct.
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's some feedback. I recommend making a few tweaks.
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
I hope it's OK to clarify the PR title: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My opinion is that this is almost /lgtm. The main thing that I think needs change to make this mergeable is the text blocks that read:
If you don't see a command prompt, try pressing enter.
In some ways, this isn't sample output, and it's a detail that I think is OK to skip. If keeping it in, I would prefix the sample with something like “kubectl displays a hint:”
As this is a cleanup PR, it's not making things worse but it is missing a few things I would prefer to see fixed. Everything below this line is optional to fix (in my opinion) / can wait for a future PR:
min-kubernetes-server-version
. @sharjeelaziz, have a look at some of the other task pages and you'll see examples of where this is set. Adding that metadata makes the{{< version-check >}}
shortcode much more relevant.- “And expose it via a service.”—I'd change this to “And expose it via a Service:”
- If I were updating the page I think I would convert the
access-nginx
NetworkPolicy into a downloadable resource using{{< codenew >}}
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
From a quick skim, this looks OK to me. |
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
content/en/docs/tasks/administer-cluster/declare-network-policy.md
Outdated
Show resolved
Hide resolved
* Reworded paragraphs to reduce ambiguity. * Added min-kubernetes-server-version metadata. * Converted yaml to a downloadable resource.
Thanks @sharjeelaziz . This looks good. |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kbhawkey The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
* Reworded paragraphs to reduce ambiguity. * Added min-kubernetes-server-version metadata. * Converted yaml to a downloadable resource.
* Reworded paragraphs to reduce ambiguity. * Added min-kubernetes-server-version metadata. * Converted yaml to a downloadable resource.