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

📖 Documentation improvements: suggestions for team leads #9270

Merged
merged 1 commit into from
Aug 23, 2023

Conversation

Prajyot-Parab
Copy link
Contributor

What this PR does / why we need it:
Part of #9216

  • Doc improvement (add a recommendation to leads tasks):Communicate and set clear expectations between the leads and the shadows about timeline and rotation.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #9216

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label labels Aug 22, 2023
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 22, 2023
@Prajyot-Parab
Copy link
Contributor Author

/cc @furkatgofurov7
/area documentation

@k8s-ci-robot k8s-ci-robot added area/documentation Issues or PRs related to documentation and removed do-not-merge/needs-area PR is missing an area label labels Aug 22, 2023
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

The wording looks good in general- but I think this sort of information might fit better in the release team doc - that's where we have the existing time commitment info.

It would be better IMO to keep this doc as a more focused task list.

@Prajyot-Parab
Copy link
Contributor Author

The wording looks good in general- but I think this sort of information might fit better in the release team doc - that's where we have the existing time commitment info.

It would be better IMO to keep this doc as a more focused task list.

Noted will move over the text there.

Copy link
Member

@furkatgofurov7 furkatgofurov7 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, few suggestions inline:

docs/release/release-team.md Outdated Show resolved Hide resolved
docs/release/release-team.md Outdated Show resolved Hide resolved
docs/release/release-team.md Outdated Show resolved Hide resolved
Signed-off-by: Prajyot-Parab <prajyot.parab2@ibm.com>
@sbueringer
Copy link
Member

/approve

Thank you very much for improving the docs.

Leaving lgtm to folks from the release team to merge it

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 23, 2023
@sbueringer
Copy link
Member

sbueringer commented Aug 23, 2023

@furkatgofurov7 Sort of related. We have to discuss it but I would be in favor of giving "cluster-api-release-team" reviewers and "cluster-api-relase-lead" approver rights on the docs/release folder (basically same as CHANGELOG)

@killianmuldoon
Copy link
Contributor

@furkatgofurov7 Sort of related. We have to discuss it but I would be in favor of giving "cluster-api-release-team" reviewers and "cluster-api-relase-lead" approver rights on the docs/release folder (basically same as CHANGELOG)

sounds like a very good idea to me

@furkatgofurov7
Copy link
Member

@furkatgofurov7 Sort of related. We have to discuss it but I would be in favor of giving "cluster-api-release-team" reviewers and "cluster-api-relase-lead" approver rights on the docs/release folder (basically same as CHANGELOG)

@sbueringer sounds like a good idea to me as well

@furkatgofurov7
Copy link
Member

I think we need to propose it in the next office hours, perhaps (as we always do)?

@sbueringer
Copy link
Member

I think we need to propose it in the next office hours, perhaps (as we always do)?

I think it doesn't hurt and we're not in a rush. But feel free to open a PR already and cc maintainers

Copy link
Member

@furkatgofurov7 furkatgofurov7 left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @Prajyot-Parab!

/lgtm
/hold

in case @killianmuldoon has further comments, feel free to unhold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 23, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 23, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: af95458b938ba9383c31e5cd6159fbbe280af16a

Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

All good from my side!

/lgtm
/approve

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 23, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: killianmuldoon, sbueringer

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 merged commit 67b5644 into kubernetes-sigs:main Aug 23, 2023
20 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.6 milestone Aug 23, 2023
@furkatgofurov7
Copy link
Member

I think we need to propose it in the next office hours, perhaps (as we always do)?

I think it doesn't hurt and we're not in a rush. But feel free to open a PR already and cc maintainers

hey, here it is: #9294

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. area/documentation Issues or PRs related to documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Improvements (v1.6 release cycle)
5 participants