📖 release: restructure release docs team roles #10651

dhij · 2024-05-21T02:12:07Z

What this PR does / why we need it:

This PR breaks up the lengthy release tasks doc by team as suggested in #10354

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 #10354

linux-foundation-easycla · 2024-05-21T02:12:11Z

The committers listed above are authorized under a signed CLA.

✅ login: dhij / name: David Hwang (b5df22e, 9ae96b5, 7ff1221, 1dce9ce, 560f885, 8088c1e, 1226209, 8092065, 345a14f, 52bb5f8, 9fc918d)

k8s-ci-robot · 2024-05-21T02:12:16Z

Welcome @dhij!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-05-21T02:12:17Z

Hi @dhij. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

dhij · 2024-05-21T02:22:32Z

/area documentation

chrischdi · 2024-05-21T10:44:37Z

/ok-to-test

docs/release/role-handbooks/ci-signal/README.md

dhij · 2024-06-02T12:33:58Z

@chrischdi I fixed the broken links and would appreciate if you could have a look 🙏

When this PR gets merged, I will need a follow-up PR to fix a bunch of broken links to release-tasks.md since that file would no longer exist (ex. in .github/ISSUE_TEMPLATE). I saw that including those link changes in this PR will break the CI since those are absolute https:// links.

chrischdi · 2024-07-16T16:17:56Z

docs/release/role-handbooks/release-lead/README.md

+- [Tasks](#tasks)
+  - [Finalize release schedule and team](#finalize-release-schedule-and-team)
+  - [Add/remove release team members](#addremove-release-team-members)
+  - [Prepare main branch for development of the new release](#prepare-main-branch-for-development-of-the-new-release)


Doesn't this TOC miss items which are there? e.g.
Optional] Track Release and Improvement tasks

Thank you for pointing that out, I addressed this in my most recent commits.

chrischdi · 2024-07-16T16:22:57Z

docs/release/release-team.md

+
+* The examples in these documents are based on the v1.6 release cycle.
+* The documents focus on tasks that are done for every release. One-time improvement tasks are out of scope.
+* If a task is prefixed with `[Track]` it means it should be ensured that this task is done, but the folks with the corresponding role are not responsible to do it themselves.


Should we have this note in each handbook?

I moved this bullet point to each of the handbooks in my most recent commits 👍

chrischdi · 2024-07-16T16:24:05Z

docs/release/release-team.md

+**Notes**:
+
+* The examples in these documents are based on the v1.6 release cycle.
+* The documents focus on tasks that are done for every release. One-time improvement tasks are out of scope.


Does this still make sense as is?

I removed this line as it is not relevant anymore.

sbueringer · 2024-08-15T05:10:34Z

@dhij Do you have time to address the findings above?

dhij · 2024-08-15T12:12:43Z

@sbueringer 👋 sorry for the delay, yes i will get to it 🙂

dhij · 2024-08-16T01:38:25Z

@chrischdi @sbueringer 👋 i addressed your comments and would appreciate another review 🙏

There were 3 new commits to the release-task.md in the meantime and since the release-task.md file is removed as part of this PR, I had to manually cherry-pick the changes into the new role-handbooks docs accordingly.

chrischdi · 2024-08-20T11:01:55Z

/lgtm
/approve

Will do a small PR on-top after merging.

k8s-ci-robot · 2024-08-20T11:02:01Z

LGTM label has been added.

Git tree hash: 316e95aa40995625d83deca3c0aea380fec97293

k8s-ci-robot · 2024-08-20T11:02:02Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chrischdi

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:

~~OWNERS~~ [chrischdi]

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 requested review from chiukapoor and pravarag May 21, 2024 02:12

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label labels May 21, 2024

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 21, 2024

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels May 21, 2024

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 May 21, 2024

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 21, 2024

chrischdi reviewed May 21, 2024

View reviewed changes

docs/release/role-handbooks/ci-signal/README.md Outdated Show resolved Hide resolved

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 21, 2024

dhij force-pushed the dhij/restructure-release-doc branch from da82f2d to 2e8b9d7 Compare June 2, 2024 11:32

dhij force-pushed the dhij/restructure-release-doc branch from 9bb6435 to c032422 Compare June 2, 2024 12:24

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 2, 2024

dhij requested a review from chrischdi June 2, 2024 12:34

chrischdi reviewed Jul 16, 2024

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 7, 2024

dhij added 11 commits August 15, 2024 21:09

restructure release docs team roles

9fc918d

nit: remove spacing

560f885

fix broken links

345a14f

add missing tasks in release-lead handbook

8092065

replace release-tasks.md relative paths with role-handbooks links

7ff1221

replace https path with relative path

52bb5f8

manually cherry-pick cefe990

b5df22e

manually cherry-pick 03e432c

8088c1e

manually cherry-pick a15a701 and remove release-tasks.md

1dce9ce

docs: add missing TOC in release-lead handbook

1226209

docs: move instruction on [Track] to each role handbooks

9ae96b5

dhij force-pushed the dhij/restructure-release-doc branch from d356ac5 to 9ae96b5 Compare August 16, 2024 01:29

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 16, 2024

dhij requested a review from chrischdi August 16, 2024 01:31

k8s-ci-robot assigned chrischdi Aug 20, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 20, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 20, 2024

k8s-ci-robot merged commit 3abe305 into kubernetes-sigs:main Aug 20, 2024
21 checks passed

k8s-ci-robot added this to the v1.9 milestone Aug 20, 2024

chrischdi mentioned this pull request Aug 20, 2024

📖 Sync back missing changes from original doc #11072

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 release: restructure release docs team roles #10651

📖 release: restructure release docs team roles #10651

dhij commented May 21, 2024 •

edited

Loading

linux-foundation-easycla bot commented May 21, 2024 •

edited

Loading

k8s-ci-robot commented May 21, 2024

k8s-ci-robot commented May 21, 2024

dhij commented May 21, 2024

chrischdi commented May 21, 2024

dhij commented Jun 2, 2024 •

edited

Loading

chrischdi Jul 16, 2024

dhij Aug 16, 2024

chrischdi Jul 16, 2024

dhij Aug 16, 2024

chrischdi Jul 16, 2024

dhij Aug 16, 2024

sbueringer commented Aug 15, 2024

dhij commented Aug 15, 2024

dhij commented Aug 16, 2024 •

edited

Loading

chrischdi commented Aug 20, 2024

k8s-ci-robot commented Aug 20, 2024

k8s-ci-robot commented Aug 20, 2024

📖 release: restructure release docs team roles #10651

📖 release: restructure release docs team roles #10651

Conversation

dhij commented May 21, 2024 • edited Loading

linux-foundation-easycla bot commented May 21, 2024 • edited Loading

k8s-ci-robot commented May 21, 2024

k8s-ci-robot commented May 21, 2024

dhij commented May 21, 2024

chrischdi commented May 21, 2024

dhij commented Jun 2, 2024 • edited Loading

chrischdi Jul 16, 2024

Choose a reason for hiding this comment

dhij Aug 16, 2024

Choose a reason for hiding this comment

chrischdi Jul 16, 2024

Choose a reason for hiding this comment

dhij Aug 16, 2024

Choose a reason for hiding this comment

chrischdi Jul 16, 2024

Choose a reason for hiding this comment

dhij Aug 16, 2024

Choose a reason for hiding this comment

sbueringer commented Aug 15, 2024

dhij commented Aug 15, 2024

dhij commented Aug 16, 2024 • edited Loading

chrischdi commented Aug 20, 2024

k8s-ci-robot commented Aug 20, 2024

k8s-ci-robot commented Aug 20, 2024

dhij commented May 21, 2024 •

edited

Loading

linux-foundation-easycla bot commented May 21, 2024 •

edited

Loading

dhij commented Jun 2, 2024 •

edited

Loading

dhij commented Aug 16, 2024 •

edited

Loading