Issue 2755 - Troubleshooting PRs by mpetason · Pull Request #2854 · knative/docs

mpetason · 2020-09-24T18:21:20Z

Fixes #2755

Proposed Changes

Added a troubleshooting section with basic information

…ing issues

…al issues

mpetason · 2020-09-24T18:29:15Z

Looking for feedback on some of the sections. I added some basic information but am not an expert on each section.

abrennan89 · 2020-09-25T13:41:39Z

To fix #1 either you need to force push your PR or someone @ Google has to manually add the label I think, so I'd add that maybe.
Thanks @mpetason !

abrennan89 · 2020-09-25T13:43:50Z

CONTRIBUTING.md


+### Common Troubleshooting issues for PRs
+
+1. CLA fails even though you have signed a CLA. This can happen if someone accepts and commits suggestions due to the email address not matching the address on record for the CLA. 


Suggested change

1. CLA fails even though you have signed a CLA. This can happen if someone accepts and commits suggestions due to the email address not matching the address on record for the CLA.

1. The CLA check fails even though you have signed the CLA. This may occur if you accept and commit suggestions in a pull request from another person's account, because the email address of that account doesn't match the address on record for the CLA.

IIUC this is generally because Github shows that commit as co-authored by the two parties (author and suggester) and uses their primary github email address as the commit email.

I'd love it if CLA bot didn't blow up 9/10 times on suggested edits. It's honestly turned the feature from something I missed from Google's Critique to something I hardly think folks should use at all (cc @thisisnotapril , not sure what kinda juice you have with the team 😉 )

abrennan89 · 2020-09-25T13:45:25Z

CONTRIBUTING.md

+
+1. CLA fails even though you have signed a CLA. This can happen if someone accepts and commits suggestions due to the email address not matching the address on record for the CLA. 
+
+1. Test Fails. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts then you may want to rerun the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time as the tasks. 


Suggested change

1. Test Fails. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts then you may want to rerun the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time as the tasks.

1. One or more tests are failing. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts, try rerunning the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time.

abrennan89 · 2020-09-25T13:45:53Z

CONTRIBUTING.md

+
+1. Test Fails. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts then you may want to rerun the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time as the tasks. 
+
+1. Previews are not working - WIP (not sure what's causing this)


This looks like stagebot may be fixed now @mattmoor ? It has been working for me lately.

It only runs when the /approve bit is flipped, which makes it seem somewhat unreliable.

This is basically the only piece of knobots that IDK how to turn into github actions, and so I've kinda been hoping a good alternative would present itself. Perhaps we could even get proper netlify preview on this repo (like on website)? @evankanderson @RichieEscarez would know more.

abrennan89 · 2020-09-25T13:49:55Z

CONTRIBUTING.md

+
+1. Previews are not working - WIP (not sure what's causing this)
+
+1. Cherrypicking - WIP (not an expert on this)


This doesn't really belong in TS maybe, I don't think it's something we have any automation for - if we don't, could we add it based on labels @evankanderson @mattmoor ? I don't know how to do this yet really, just manual CPs, which like I said doesn't really go here in TS?

Automation would be really useful and probably fun to write here.

cc @n3wscott

abrennan89

Some suggestions but otherwise looks good 👍 can't think of anything else to add but I'd imagine this doc will expand over time if we find any other issues anyway

mattmoor · 2020-09-25T14:03:49Z

CONTRIBUTING.md

 channel](https://knative.slack.com/) to get input on your ideas or find areas to
 contribute before creating a PR.

+### Common Troubleshooting issues for PRs


I'd think DEVELOPMENT.md is probably a good place for this. I don't feel super strongly, but my spidey sense seems to think this file is largely boilerplate across the repos (I think some may even redirect folks to a common one in community?)...

Sorry - thought this was the last part "other issue", I'll take a look and see if we should move it over from contrib to development

mpetason · 2020-09-30T15:33:49Z

@abrennan89 It looks like @mattmoor is suggesting that we move this to Devleopment.md. Maybe we should copy one from the other projects(serving) and update it based on our needs? I actually reference the serving dev guide whenever I setup an environment for knative projects.

abrennan89 · 2020-09-30T20:22:25Z

@mpetason I'm trying to leave @RichieEscarez alone and not tag him for reviews, but I think this one would be better suited for himself than me 😄 he has more expertise in this stuff.

mpetason · 2020-09-30T20:23:37Z

I'll add @evankanderson too since he works across multiple projects and may have some suggestions.

abrennan89 · 2020-12-03T19:05:59Z

DEVELOPMENT.md

+
+### Common Troubleshooting issues for PRs
+
+1. The CLA check fails even though you have signed the CLA. This may occur if you accept and commit suggestions in a pull request from another person's account, because the email address of that account doesn't match the address on record for the CLA. The commit will show up as co-authored, which can cause issues if your public email address has not signed the CLA.


Doesn't say how to fix it though? I think force pushing fixes it so maybe add that to the doc if the CLA stuff isn't going to be fixed for the time being? cc @thisisnotapril @mattmoor

abrennan89 · 2020-12-03T19:06:26Z

DEVELOPMENT.md

+
+1. One or more tests are failing. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts, try rerunning the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time.
+
+1. Other Issues/Unsure - reach out in the #docs slack channel and someone will be happy to help out.


Suggested change

1. Other Issues/Unsure - reach out in the #docs slack channel and someone will be happy to help out.

1. Other Issues/Unsure - reach out in the #docs Slack channel and someone will be happy to help out.

abrennan89

Approving since this looks good as a first iteration. I'd get an LGTM from @evankanderson or @RichieEscarez though ;) Thanks Mike!

knative-prow-robot · 2020-12-03T19:08:27Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, mpetason

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [abrennan89]

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

abrennan89 · 2021-01-28T17:47:55Z

Since Mike probably won't be around to do more work on this, I'm going to go ahead and merge what we have. We can make updates or iterations later, but this is a good start.

/lgtm

* Started work on updating contributing docs for different troubleshooting issues * Updated formatting * added section to default to reaching out in docs if you have additional issues * Updated based on reviews * Removed trailing spaces * basic edit of development.md to match docs - still wip * added newline to end of file * Removed serving reference and updated based on reviews/comments * Removed empty sections * Cleaned up trailing whitespace

Mike Petersen added 3 commits September 24, 2020 11:16

Started work on updating contributing docs for different troubleshoot…

23756ce

…ing issues

Updated formatting

e81a814

added section to default to reaching out in docs if you have addition…

4f5082b

…al issues

knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 24, 2020

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Sep 24, 2020

knative-prow-robot requested review from RichieEscarez and samodell September 24, 2020 18:21

knative-prow-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 24, 2020

abrennan89 requested review from abrennan89 and mattmoor and removed request for samodell September 25, 2020 13:39

abrennan89 reviewed Sep 25, 2020

View reviewed changes

mattmoor reviewed Sep 25, 2020

View reviewed changes

Mike Petersen added 2 commits September 30, 2020 08:29

Updated based on reviews

a14cb40

Removed trailing spaces

1d0845c

basic edit of development.md to match docs - still wip

12f41c2

knative-prow-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 6, 2020

Mike Petersen added 3 commits October 8, 2020 09:06

added newline to end of file

4b0f89a

Removed serving reference and updated based on reviews/comments

5ddc29b

Removed empty sections

259ef47

Cleaned up trailing whitespace

c3ed8f9

mpetason changed the title ~~[WIP] Issue 2755 - Troubleshooting PRs~~ Issue 2755 - Troubleshooting PRs Oct 28, 2020

knative-prow-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 28, 2020

abrennan89 requested a review from evankanderson December 3, 2020 19:04

abrennan89 reviewed Dec 3, 2020

View reviewed changes

abrennan89 approved these changes Dec 3, 2020

View reviewed changes

knative-prow-robot added the approved label Dec 3, 2020

knative-prow-robot assigned abrennan89 Jan 28, 2021

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 28, 2021

abrennan89 added this to the v0.21.0 milestone Jan 28, 2021

knative-prow-robot merged commit c1ac45f into knative:master Jan 28, 2021


		### Common Troubleshooting issues for PRs

		1. CLA fails even though you have signed a CLA. This can happen if someone accepts and commits suggestions due to the email address not matching the address on record for the CLA.

	1. CLA fails even though you have signed a CLA. This can happen if someone accepts and commits suggestions due to the email address not matching the address on record for the CLA.
	1. The CLA check fails even though you have signed the CLA. This may occur if you accept and commit suggestions in a pull request from another person's account, because the email address of that account doesn't match the address on record for the CLA.


		1. CLA fails even though you have signed a CLA. This can happen if someone accepts and commits suggestions due to the email address not matching the address on record for the CLA.

		1. Test Fails. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts then you may want to rerun the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time as the tasks.

	1. Test Fails. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts then you may want to rerun the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time as the tasks.
	1. One or more tests are failing. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts, try rerunning the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time.


		1. Test Fails. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts then you may want to rerun the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time as the tasks.

		1. Previews are not working - WIP (not sure what's causing this)


		1. Previews are not working - WIP (not sure what's causing this)

		1. Cherrypicking - WIP (not an expert on this)


		1. One or more tests are failing. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts, try rerunning the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time.

		1. Other Issues/Unsure - reach out in the #docs slack channel and someone will be happy to help out.

Comments

Conversation

mpetason commented Sep 24, 2020

Proposed Changes

Uh oh!

mpetason commented Sep 24, 2020

Uh oh!

abrennan89 commented Sep 25, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattmoor Sep 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abrennan89 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mpetason Sep 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mpetason commented Sep 30, 2020

Uh oh!

abrennan89 commented Sep 30, 2020

Uh oh!

mpetason commented Sep 30, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abrennan89 left a comment

Choose a reason for hiding this comment

Uh oh!

knative-prow-robot commented Dec 3, 2020

Uh oh!

abrennan89 commented Jan 28, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mattmoor Sep 25, 2020 •

edited

Loading

mpetason Sep 30, 2020 •

edited

Loading