-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Update contributing docs #2387
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
Update contributing docs #2387
Conversation
eace36e to
2f3f903
Compare
7c682fe to
73eccaf
Compare
|
Verified that the website actually renders fine, not the errors shown in https://docs-2387.default.docs-on-the-rocks.io/community/contributing/ |
|
/assign @carieshmarie @abrennan89 |
|
/assign @abrennan89 |
abrennan89
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small nits, but overall this looks fantastic! Thanks @evankanderson 🥳
|
@abrennan89 This is ready for another look |
| 2. Use the [correct template](https://github.com/knative/docs/issues/new) for | ||
| your new issue. There are two templates available: | ||
| - **Bug report**: If you're reporting an error in the existing documentation, | ||
| use this template. This could be anything from broken samples to typos. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is a broken sample? Should this maybe be broken link instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A broken sample would presumably be one of the code samples which no longer compiles or works properly due to ecosystem changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A broken sample would presumably be one of the code samples which no longer compiles or works properly due to ecosystem changes.
CONTRIBUTING.md
Outdated
| meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to | ||
| accommodate contributors in both the EMEA and APAC timezones. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The meeting is only at 9am now I think (11.30am CDT)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
9:30am, corrected. We seem to have lost the afternoon meeting that was the other weeks. Given the current level of WG activity, this seems reasonable. Updated.
CONTRIBUTING.md
Outdated
| meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to | ||
| accommodate contributors in both the EMEA and APAC timezones. | ||
| [Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com) | ||
| to see the exact dates on the Knative working group calendar. If you're |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe split this into a new paragraph to make it more readable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
abrennan89
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
couple of very minor things, otherwise lgtm!
|
w00t w00t, amazing work @evankanderson ✨ |
|
We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. ℹ️ Googlers: Go here for more info. |
|
@abrennan89 -- have you been added to the red hat/Google CLA list? I may back out there last two suggestions and apply them as my own commits to move this forward. |
353cede to
7c82285
Compare
7c82285 to
d7be5df
Compare
|
CLAs look good, thanks! ℹ️ Googlers: Go here for more info. |
|
Updated and CLA looks good. I'll need an |
|
We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. ℹ️ Googlers: Go here for more info. |
1 similar comment
|
We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. ℹ️ Googlers: Go here for more info. |
fcca3fd to
7da72f8
Compare
|
CLAs look good, thanks! ℹ️ Googlers: Go here for more info. |
|
I backed out the suggestions so I don't have to do the CLA-bot, and made the changes myself (and squashed the commits to make the log nicer). |
|
@evankanderson: The following test failed, say
Full PR test history. Your PR dashboard. 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/test-infra repository. I understand the commands that are listed here. |
|
The link check is fixed by #2468 |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: evankanderson, vaikas 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 |
The docs contribution information used to be mixed with the general community information, and was moved to https://github.com/knative/community when that was split out.
With the Hugo build, there's no reason for the contributing docs not to live in the docs repo.
Fixes #1917 #2322
Proposed Changes