website icon indicating copy to clipboard operation
website copied to clipboard

Document labels, annotations and taints for JobSet

Open Adarsh-verma-14 opened this issue 1 year ago • 21 comments

Adding labels and annotation for JobSet in https://github.com/kubernetes/website/blob/main/content/en/docs/reference/labels-annotations-taints/_index.md

Fixes #47373

/language en

Adarsh-verma-14 avatar Aug 07 '24 17:08 Adarsh-verma-14

Hi @sftim ,could you review on these changes if anythings need to change let me know .

Adarsh-verma-14 avatar Aug 07 '24 17:08 Adarsh-verma-14

Pull request preview available for checking

Built without sensitive environment variables

Name Link
Latest commit fc4c0c7b47dc3cdd17cda89977fd68eed24dc3dd
Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6703725bf718730008f25363
Deploy Preview https://deploy-preview-47383--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.

netlify[bot] avatar Aug 07 '24 17:08 netlify[bot]

cc @ahg-g @danielvegamyhre

kannon92 avatar Aug 08 '24 16:08 kannon92

Thanks for working on this @kannon92, I added a couple comments

@Adarsh-verma-14 is the one who worked on this.

kannon92 avatar Aug 08 '24 17:08 kannon92

There is also one taint, so:

/retitle Document labels, annotations and taints for JobSet

sftim avatar Aug 08 '24 17:08 sftim

/sig apps

sftim avatar Aug 08 '24 17:08 sftim

Thanks for working on this @kannon92, I added a couple comments

@Adarsh-verma-14 is the one who worked on this.

Woops, sorry about that @Adarsh-verma-14! Thanks for the contribution :)

danielvegamyhre avatar Aug 08 '24 21:08 danielvegamyhre

Tide, is this OK to merge?

sftim avatar Aug 19 '24 14:08 sftim

Tide, is this OK to merge?

@sftim , I am not getting this, could you give more clarification ?

Adarsh-verma-14 avatar Aug 22 '24 15:08 Adarsh-verma-14

I am not getting this, could you give more clarification ?

I wanted to nudge Tide to recheck the PR status (it did).

sftim avatar Aug 22 '24 15:08 sftim

@sftim any blockers here? Scanning through it looks like comments have been addressed

danielvegamyhre avatar Aug 28 '24 02:08 danielvegamyhre

This PR is ready for a review (any reviewer for English).

sftim avatar Aug 28 '24 09:08 sftim

This PR is ready for a review (any reviewer for English).

Thanks! Would you mind tagging a reviewer for this? I'm not sure who to add.

danielvegamyhre avatar Sep 08 '24 18:09 danielvegamyhre

https://github.com/kubernetes/website/pull/47383#event-13795502968 shows the suggested reviewers. I'll take a look if I get time.

sftim avatar Sep 09 '24 09:09 sftim

Waiting on author updates and then on tech LGTM.

sftim avatar Sep 11 '24 08:09 sftim

Thanks @Adarsh-verma-14, please tag me when this is ready for another review

danielvegamyhre avatar Sep 14 '24 17:09 danielvegamyhre

Thanks @Adarsh-verma-14, please tag me when this is ready for another review

Sure

Adarsh-verma-14 avatar Sep 14 '24 17:09 Adarsh-verma-14

Hi @danielvegamyhre , I have updated changes as suggested now you can review on it .

Adarsh-verma-14 avatar Sep 20 '24 05:09 Adarsh-verma-14

Sorry, I'm against this change because

  • JobSet is not something we can get from vanilla Kubernetes. Yes. The mentioned labels or annotations all carry the k8s.io domain name, which is reserved. But this doesn't mean that they are "official".
  • We could add notes (or warnings) to all these labels or annotations -- you can use them only when you deployed the jobset related manifests. They are not available by default on your cluster.
  • Or, better yet, document these labels/annotations on a different page. The current page is already lengthy (>2400 lines). Without differentiating builtin labels/annotations from those from other projects, we will end up with a huge file pretty soon.

tengqm avatar Sep 22 '24 02:09 tengqm

Thanks for the comment @tengqm, but JobSet is part of the Kubernetes project. I don't think we should force SIG Apps to reorganize a long page just to register their labels and annotations, even if that work is a good idea for the long term.

sftim avatar Sep 22 '24 11:09 sftim

/lgtm for JobSet

@sftim this is ready for SIG docs review

danielvegamyhre avatar Sep 29 '24 16:09 danielvegamyhre

@Adarsh-verma-14 can you address sftim@'s comments as soon as you can please? The JobSet blog post PR is blocked by this one, so we are hoping to get it merged as soon as possible :)

danielvegamyhre avatar Oct 04 '24 05:10 danielvegamyhre

@Adarsh-verma-14 can you address sftim@'s comments as soon as you can please? The JobSet blog post PR is blocked by this one, so we are hoping to get it merged as soon as possible :)

sure

Adarsh-verma-14 avatar Oct 04 '24 18:10 Adarsh-verma-14

[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 ask for approval from sftim. For more information see the Kubernetes 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 avatar Oct 07 '24 05:10 k8s-ci-robot

Hi , I have updated these changes as suggested by @sftim . PTAL!!

Adarsh-verma-14 avatar Oct 07 '24 05:10 Adarsh-verma-14

Friendly ping @sftim

ahg-g avatar Oct 20 '24 02:10 ahg-g

@Adarsh-verma-14 can you address the last few comments here? Thanks!

danielvegamyhre avatar Oct 25 '24 15:10 danielvegamyhre

Hello, anything blocking this one?

ahg-g avatar Nov 18 '24 01:11 ahg-g

There's a lot of pending feedback. I noticed https://github.com/kubernetes/website/pull/47383#discussion_r1846197389

sftim avatar Nov 18 '24 09:11 sftim

since @Adarsh-verma-14 is not responding, I will clone it and submit a PR tomorrow to close this

ahg-g avatar Nov 19 '24 03:11 ahg-g