Skip to content

Conversation

@evankanderson
Copy link
Member

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

@googlebot googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Apr 13, 2020
@knative-prow-robot knative-prow-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. approved labels Apr 13, 2020
@evankanderson
Copy link
Member Author

Verified that the website actually renders fine, not the errors shown in https://docs-2387.default.docs-on-the-rocks.io/community/contributing/

@evankanderson
Copy link
Member Author

/assign @carieshmarie @abrennan89

@evankanderson
Copy link
Member Author

/assign @abrennan89

Copy link
Contributor

@abrennan89 abrennan89 left a 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 🥳

@evankanderson
Copy link
Member Author

@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.
Copy link
Contributor

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?

Copy link
Member Author

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.

Copy link
Member Author

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
Comment on lines 77 to 78
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.
Copy link
Contributor

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)?

Copy link
Member Author

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
Copy link
Contributor

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Contributor

@abrennan89 abrennan89 left a 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!

@jonatasbaldin
Copy link
Contributor

w00t w00t, amazing work @evankanderson

@googlebot
Copy link

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.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: no Indicates the PR's author has not signed the CLA. and removed cla: yes Indicates the PR's author has signed the CLA. labels May 5, 2020
@evankanderson
Copy link
Member Author

@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.

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes Indicates the PR's author has signed the CLA. and removed cla: no Indicates the PR's author has not signed the CLA. labels May 6, 2020
@evankanderson
Copy link
Member Author

Updated and CLA looks good. I'll need an /lgtm for this to be submitted.

@googlebot
Copy link

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.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

1 similar comment
@googlebot
Copy link

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.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: no Indicates the PR's author has not signed the CLA. and removed cla: yes Indicates the PR's author has signed the CLA. labels May 14, 2020
@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes Indicates the PR's author has signed the CLA. and removed cla: no Indicates the PR's author has not signed the CLA. labels May 14, 2020
@evankanderson
Copy link
Member Author

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).

@knative-prow-robot
Copy link
Contributor

@evankanderson: The following test failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
pull-knative-docs-markdown-link-check 7da72f8 link /test pull-knative-docs-markdown-link-check

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.

@evankanderson
Copy link
Member Author

The link check is fixed by #2468

@vaikas
Copy link
Contributor

vaikas commented May 26, 2020

/lgtm
/approve

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label May 26, 2020
@knative-prow-robot
Copy link
Contributor

[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:
  • OWNERS [evankanderson,vaikas]

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

@knative-prow-robot knative-prow-robot merged commit 23c337c into knative:master May 26, 2020
@abrennan89 abrennan89 mentioned this pull request Jun 11, 2020
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

New "how to contribute to docs" instructions

9 participants