Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

SergeyKanzhelev
Copy link
Member

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.

@k8s-ci-robot k8s-ci-robot requested a review from mrunalp January 7, 2025 19:54
@k8s-ci-robot k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 7, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign nate-double-u for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject language/en Issues or PRs related to English language size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 7, 2025
Copy link

netlify bot commented Jan 7, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 3c15ec3
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/677d866db788da000887852e
😎 Deploy Preview https://deploy-preview-49333--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@SergeyKanzhelev
Copy link
Member Author

@shannonxtreme I would appreciate any feedback on this.

Sergey Kanzhelev (Google)
Mrunal Patel (RedHat)
---

Copy link
Contributor

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

Copy link
Contributor

@sftim sftim left a 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).

@sftim
Copy link
Contributor

sftim commented Jan 9, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/node Categorizes an issue or PR as relevant to SIG Node. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Development

Successfully merging this pull request may close these issues.

4 participants