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

Refactor the label-annotation-taints page #41540

Merged
merged 1 commit into from
Jun 11, 2023

Conversation

tengqm
Copy link
Contributor

@tengqm tengqm commented Jun 8, 2023

The page is currently a mixture of labels, annotations and taints. The line wrappings are terrible. This PR attempts to refactor the page against the style guide.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 8, 2023
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jun 8, 2023
@k8s-ci-robot k8s-ci-robot requested a review from sftim June 8, 2023 10:24
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jun 8, 2023
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.

LGTM

`feature.node.kubernetes.io/<feature-name>: <true>`.
Used on: Node

These lables are used by the Node Feature Discovery (NFD) component to advertise
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(nit)

Suggested change
These lables are used by the Node Feature Discovery (NFD) component to advertise
These labels are used by the Node Feature Discovery (NFD) component to advertise

@netlify
Copy link

netlify bot commented Jun 8, 2023

Pull request preview available for checking

Name Link
🔨 Latest commit 0de5b70
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6481b5761a53470008dc8cb6
😎 Deploy Preview https://deploy-preview-41540--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 settings.

The page is currently a mixture of labels, annotations and taints.
The line wrappings are terrible. This PR attempts to refactor the page
against the style guide.
@sftim
Copy link
Contributor

sftim commented Jun 8, 2023

To help reviewers @tengqm, you could pop a link to https://deploy-preview-41540--kubernetes-io-main-staging.netlify.app/docs/reference/labels-annotations-taints/ in the PR description.

@sftim
Copy link
Contributor

sftim commented Jun 8, 2023

A side effect of this work: if we want to, we can break it our into a file per item (like the glossary).

@sftim
Copy link
Contributor

sftim commented Jun 10, 2023

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 10, 2023
@sftim
Copy link
Contributor

sftim commented Jun 10, 2023

/kind cleanup

@k8s-ci-robot k8s-ci-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Jun 10, 2023
@windsonsea
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 11, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: e1c3582efac7ea17d47940b7283bf10fd58b240e

@k8s-ci-robot k8s-ci-robot merged commit 13a9d24 into kubernetes:main Jun 11, 2023
6 of 7 checks passed
@tengqm tengqm deleted the wrap-labels branch June 11, 2023 23:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants