kubernetes / contributor-site

Code for kubernetes.dev
https://www.kubernetes.dev
Apache License 2.0
67 stars 149 forks source link

Create prow-and-tide-for-kubernetes-contributors.md #338

Closed fsmunoz closed 1 year ago

fsmunoz commented 1 year ago

This is the follow-up to https://github.com/kubernetes/contributor-site/pull/313 , picking it up from @chris-short; I've kept all the history of the previous reviews, and made changes to address the pending comments:

/cc @jberkus @mrbobbytables @kaslin /assign @sftim @mrbobbytables @parispittman

jberkus commented 1 year ago

It's still not clear what the goal of the blog post is. It's titled "Prow and Tide for Kubernetes Contributors", which sounds like a basic instructional article. But the article itself is comments about a handful of Prow commands, in no real order, with varying amounts of details about each, and without a complete usage example supplied for any.

What would be publishable is a blog post that either went in depth on two prow-and-tide cases (e.g. merge and label sync) would be good, or a blog that was more like "my 7 favorite Prow commands" with equal amounts of explanation on each (and maybe an example for each). But in its current form, this post does not help contributors and may seriously confuse some.

fsmunoz commented 1 year ago

Thank you @jberkus . My initial approach to this was to take the article and address the pending comments, assuming that there wouldn't exist the need to any more structural changes (especially relevant since I'm not the author). I did found the article sueful though, since while contributing I've found that a lot of workflows require git commands without being really useful to clone the repo and work at the terminal.

With that said, I can try to add that information to it and provide example scenarios on why it's useful, and in that way address at least some of your concerns.

jberkus commented 1 year ago

This is looking much better, will review it later today.

fsmunoz commented 1 year ago

This is looking much better, will review it later today.

Thanks, now that I'm looking at it I could perhaps add some example PRs where the commands are used, and do a narrative around their usage there. Perhaps overkill though.

fsmunoz commented 1 year ago

@jberkus I have made some changes in line with my previous comment: I have added two real examples, one on the use of merge-method-squash, the other on the approval process. I hope this makes it even clearer for the readers.

kaslin commented 1 year ago

Needs review @chris-short @kaslin

kaslin commented 1 year ago

Still needs review @chris-short and @kaslin

chris-short commented 1 year ago

About to get on a plane. This is on the list for Monday.

jberkus commented 1 year ago

I have not reviewed it for typos, but general content is in really good shape.

fsmunoz commented 1 year ago

@kaslin @chris-short I think I reflected all proposed changes in the last commit.

kaslin commented 1 year ago

/lgtm /approve

kaslin commented 1 year ago

/lgtm

jberkus commented 1 year ago

/approve

k8s-ci-robot commented 1 year ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fsmunoz, jberkus, kaslin

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](https://github.com/kubernetes/contributor-site/blob/master/OWNERS)~~ [jberkus] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment