Update docs contributor guidelines #1193

RichieEscarez · 2019-04-17T18:56:31Z

Add docs PR details:

docs
code samples
branches
cherry picks

add 0.5 release to the list of releases page

samodell · 2019-04-17T20:07:27Z

I'm planning to do an edit of this later today.

contributing/DOCS-CONTRIBUTING.md

samodell · 2019-04-17T21:41:09Z

contributing/DOCS-CONTRIBUTING.md

+     1. Add one or more `cherrypick-#.#` labels to that PR to indicate which
+        of the past release branches should also be fixed.
+     1. If you want to complete the fix yourself (best practice), you then open
+        a subsequent PR by running `git cherry-pick [OriginalPRCommit#]` against


I don't know if the "Original PR commit" reference here makes sense; I wait until the PR is merged and then grab the squashed commit number that shows at the bottom. For example: #1143 shows 3f8fbb2

ive used the language from the template, ptal

contributing/DOCS-CONTRIBUTING.md

samodell · 2019-04-17T21:43:44Z

contributing/DOCS-CONTRIBUTING.md

+
+## Assigning reviewers
+
+For both documentation and code samples, you should assign your PR to a single


Right now, Prow automatically assigns two reviewers from the list of docs approvers and reviewers: https://github.com/knative/docs/blob/master/OWNERS_ALIASES

Prow is nice and mostly reliable but the goal here is to address the lack of SME eyes on certain items, particularly code sample related items. Instead of maintainers manually assigning items (especially when they are from peers) it would expedite a review if the author assigned a reviewer immediately.

Oh, my point was that you said explicitly to only assign it to one person, and I was just pointing out that Prow automatically assigns two, so a person could see the auto-assignments as be like, "Oops, I need it to only be assigned to one person."

But also there's some restrictions on who is able to assign issues/PRs -- I think you have to be a member of the Knative org, so some contributors (esp. first timers) might not be able to assign anyone themselves.

ah, good point. others can use /assign flag with prow, will add that

contributing/DOCS-CONTRIBUTING.md

Co-Authored-By: RichieEscarez <[email protected]>

contributing/DOCS-CONTRIBUTING.md

Co-Authored-By: RichieEscarez <[email protected]>

samodell · 2019-04-17T21:48:23Z

contributing/DOCS-CONTRIBUTING.md

+  For a list of the available branches in the `knative/docs` repo, see
+  [Documentation Releases](https://github.com/knative/docs/blob/master/doc-releases.md).
+
+## Assigning reviewers


GitHub has "Reviewers" as well as "Assignees". Should we differentiate between the two?

(Sorry, this comment was left as "pending" and didn't get batched in with my first review somehow...)

yes i agree, will add this too

Co-Authored-By: RichieEscarez <[email protected]>

RichieEscarez · 2019-04-19T00:27:40Z

Thanks for all the feedback (and the fixes)! This is ready for a second pass, PTAL

samodell · 2019-04-19T16:50:44Z

/lgtm

knative-prow-robot · 2019-04-19T16:51:10Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RichieEscarez, samodell

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~~ [RichieEscarez,samodell]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

assigning PRs and choosing branches

2458859

RichieEscarez requested a review from rgregg April 17, 2019 18:56

RichieEscarez assigned carieshmarie and samodell Apr 17, 2019

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Apr 17, 2019

knative-prow-robot added the approved label Apr 17, 2019

knative-prow-robot requested review from gyliu513 and samodell April 17, 2019 18:56

knative-prow-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 17, 2019

samodell added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs edits labels Apr 17, 2019

samodell suggested changes Apr 17, 2019

View reviewed changes

samodell removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs edits labels Apr 17, 2019

samodell and others added 3 commits April 17, 2019 18:09

Update contributing/DOCS-CONTRIBUTING.md

47771e2

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

a09bcf3

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

3770517

Co-Authored-By: RichieEscarez <[email protected]>

mhamwala reviewed Apr 18, 2019

View reviewed changes

contributing/DOCS-CONTRIBUTING.md Outdated Show resolved Hide resolved

mhamwala reviewed Apr 18, 2019

View reviewed changes

contributing/DOCS-CONTRIBUTING.md Outdated Show resolved Hide resolved

samodell and others added 10 commits April 18, 2019 12:15

Update contributing/DOCS-CONTRIBUTING.md

f4a595e

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

362cd1c

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

d1c6b3b

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

5ebf9eb

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

7291c99

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

b3631f7

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

58491e6

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

007e631

Co-Authored-By: RichieEscarez <[email protected]>

add missing link to slack

38a681c

Update contributing/DOCS-CONTRIBUTING.md

fe06c4b

Co-Authored-By: RichieEscarez <[email protected]>

samodell and others added 4 commits April 18, 2019 13:57

Update contributing/DOCS-CONTRIBUTING.md

c7e07c6

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

c6a6a0c

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

71ec008

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

d6fc3e4

Co-Authored-By: RichieEscarez <[email protected]>

samodell reviewed Apr 18, 2019

View reviewed changes

samodell and others added 18 commits April 18, 2019 14:05

Update contributing/DOCS-CONTRIBUTING.md

1e650ec

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

2834891

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

473ed88

Co-Authored-By: RichieEscarez <[email protected]>

clarify commit #

958f0ee

Update contributing/DOCS-CONTRIBUTING.md

351214d

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

dfb8852

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

fc7945b

Co-Authored-By: RichieEscarez <[email protected]>

add missing link to community samples

aa3df5b

Update contributing/DOCS-CONTRIBUTING.md

8827532

Co-Authored-By: RichieEscarez <[email protected]>

add link to Owners files that lists TWs

edf2303

Update contributing/DOCS-CONTRIBUTING.md

6abe957

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

dc559b3

Co-Authored-By: RichieEscarez <[email protected]>

Update contributing/DOCS-CONTRIBUTING.md

e542acb

Co-Authored-By: RichieEscarez <[email protected]>

consistent variables

16b6d06

remove duplicate statement

48f956a

revise wording

0999e9e

add link, fix typos, and revise for clarity

2090d71

clarify owner vs reviewer and add prow links/commands

9a83ec3

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 19, 2019

samodell approved these changes Apr 19, 2019

View reviewed changes

knative-prow-robot merged commit 39e9017 into knative:master Apr 19, 2019

RichieEscarez deleted the contributing branch May 2, 2019 17:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs contributor guidelines #1193

Update docs contributor guidelines #1193

RichieEscarez commented Apr 17, 2019

samodell commented Apr 17, 2019

samodell Apr 17, 2019

RichieEscarez Apr 19, 2019

samodell Apr 17, 2019

RichieEscarez Apr 18, 2019

samodell Apr 18, 2019 •

edited

Loading

RichieEscarez Apr 18, 2019

RichieEscarez Apr 19, 2019

samodell Apr 17, 2019

samodell Apr 18, 2019

RichieEscarez Apr 18, 2019

RichieEscarez Apr 19, 2019

RichieEscarez commented Apr 19, 2019

samodell commented Apr 19, 2019

knative-prow-robot commented Apr 19, 2019


		## Assigning reviewers

		For both documentation and code samples, you should assign your PR to a single

Update docs contributor guidelines #1193

Update docs contributor guidelines #1193

Conversation

RichieEscarez commented Apr 17, 2019

samodell commented Apr 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samodell Apr 18, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RichieEscarez commented Apr 19, 2019

samodell commented Apr 19, 2019

knative-prow-robot commented Apr 19, 2019

samodell Apr 18, 2019 •

edited

Loading