-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
The blog post: device failures handling #49333
base: main
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
@shannonxtreme I would appreciate any feedback on this. |
Sergey Kanzhelev (Google) | ||
Mrunal Patel (RedHat) | ||
--- | ||
|
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.
Some initial feedback:
- Wrap lines at ~80 characters
- Use sentence case for headings (eg: "Why Kubernetes still reigns supreme")
- Add a table caption to the table
- Use
1.
for every ordered list entry (don't use 1 2 3 4 5 6 like that) - Use the figure shortcode to embed your images, like
{{< figure src="IMAGE_PATH" alt="ALT_TEXT" >}}
.- Replace IMAGE_PATH with path to image
- Replace alt text with a description of the diagram
- Remove escape characters from the body (currently you have escaped hyphens and pound signs)
- Use the
"
character for quotation marks instead of the left and right quotation marks. - Consider using SVGs instead of PNGs if you have those available
Also, are any of the best practices / workarounds in this blog useful for an actual documentation page? Some of these feel like a good idea to have in docs
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.
We'd really prefer vector graphics for the images. See https://kubernetes.io/docs/contribute/style/diagram-guide/ (it mostly applies to blog articles too).
There's a backlog on blog article reviews @SergeyKanzhelev and the blog team are going to prioritize the older articles for publication. We should have this published within a few months, maybe sooner. |
Description
/sig node
/cc @mrunalp
This is a blog post from the talk we gave on KubeCon NA 2024. Covers a lot of topics we will be working on in sig node and beyond this year in terms of reliability and extensibility.