Update debug-cluster and crictl files to get them consistent with the… #13183
Conversation
k8s-ci-robot
added
cncf-cla: yes
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit 3281e0a https://deploy-preview-13183--kubernetes-io-master-staging.netlify.com |
|
@cody-clark please help review, thank you |
content/en/docs/tasks/_index.md
Outdated
| @@ -41,7 +41,7 @@ Run Jobs using parallel processing. | |||
|
|
|||
| Configure load balancing, port forwarding, or setup firewall or DNS configurations to access applications in a cluster. | |||
|
|
|||
| ## Monitoring, Logging, and Debugging | |||
| ## Monitoring, Logging and Debugging | |||
There was a problem hiding this comment.
I'm reluctant to approve getting rid of a serial comma... XD
There was a problem hiding this comment.
the reason here was purely grammer, nothing else. and i tried to align this file with content/en/docs/tasks/debug-application-cluster/_index.md.
At the same time i've also asked in the PR description if
should we rename the task title title: "Monitor, Log and Debug" to Monitoring, Logging and Debugging to keep alignment/ consistency ?
There was a problem hiding this comment.
Renaming the task title for consistency is a good idea.
I'm still not sold on deleting the the serial comma. "Monitoring, Logging, and Debugging" is just as correct as "Monitoring, Logging and Debugging". And I'm not ready to instigate the Oxford comma debate in sig-docs!
|
|
||
| ## A general overview of cluster failure modes | ||
|
|
||
| This is an incomplete list of things that could go wrong, and how to adjust your cluster setup to mitigate the problems. | ||
|
|
||
| Root causes: | ||
| ##### Root causes: |
There was a problem hiding this comment.
An H5 seems very specific. Was there a reason to go this deep?
There was a problem hiding this comment.
rational was to articulate the 3 pillars: Root causes, Specific scenarios & Mitigations from the rest of the actions/ text.
Initially tried to just make the text bold but in my local preview website it didn't make the difference i was expecting hence h5.
Any alternative ?
There was a problem hiding this comment.
I completely agree that those pillars should be differentiated. Don't H3s work here?
I prefer semantic markup for hierarchy over appearance. There's also the accessibility consideration: https://www.w3.org/WAI/tutorials/page-structure/headings/
Skipping heading ranks can be confusing and should be avoided where possible: Make sure that a <h2> is not followed directly by an <h4>, for example.
There was a problem hiding this comment.
ack, will give it a go and then you will see if it makes sense with h3 as part of the review
There was a problem hiding this comment.
@cody-clark please help review again, made the change from h5 to h3
… style guidelines
There was a problem hiding this comment.
Thanks, @DanyC97! Sorry for the back and forth
/lgtm
/approve
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cody-clark 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 |
k8s-ci-robot
added
the
approved
|
no problem at all @cody-clark , i'm all good |
… style guidelines (#13183)
… style guidelines
Two tasks from #12740 were covered:
question for sig-docs members:
should we rename the task title
title: "Monitor, Log and Debug"toMonitoring, Logging and Debuggingto keep alignment/ consistency ?