Skip to content
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.

Sign up for GitHub

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

Jump to bottom

📖 Add info about contributing documentation changes #4390

Merged
merged 6 commits into from
Sep 8, 2021
Merged

📖 Add info about contributing documentation changes #4390

merged 6 commits into from
Sep 8, 2021

Conversation

mig4
Copy link
Contributor

@mig4 mig4 commented Mar 29, 2021

What this PR does / why we need it:

This adds a note about working on and submitting documentation changes
which may be helpful to contributors wanting to improve documentation.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 29, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @mig4. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 29, 2021
sbueringer
sbueringer reviewed Mar 29, 2021
View reviewed changes
Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

/ok-to-test

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 29, 2021
fabriziopandini
fabriziopandini reviewed Mar 29, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
mrajashree
mrajashree reviewed Apr 8, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@fabriziopandini
Copy link
Member

@mig4 do you think to have some time to address pending comments?

@sftim
Copy link
Contributor

sftim commented Jun 17, 2021

/retest

@mrajashree mrajashree mentioned this pull request Jul 15, 2021
Closed
6 tasks
@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 19, 2021
@sbueringer
Copy link
Member

/retest

vincepri
vincepri reviewed Jul 19, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@vincepri
Copy link
Member

Thanks for this! Let's also make sure to squash commits before merging

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 20, 2021
@sbueringer
Copy link
Member

@mig4 Looks good, can you please squash the commits?

@mig4 @sbueringer
@fabriziopandini @mrajashree @vincepri
📖 Add info about contributing documentation changes
5296d7f 
This adds a note about working on and submitting documentation changes
which may be helpful to contributors wanting to improve documentation.

Co-authored-by: Stefan Büringer <4662360+sbueringer@users.noreply.github.com>
Co-authored-by: Fabrizio Pandini <fabrizio.pandini@gmail.com>
Co-authored-by: Rajashree Mandaogane <rajashree.28m@gmail.com>
Co-authored-by: Vince Prignano <vince@vincepri.com>
@mig4
Copy link
Contributor Author

mig4 commented Jul 20, 2021

@mig4 Looks good, can you please squash the commits?

Done, thanks!

@sbueringer
Copy link
Member

@mig4 Thank you!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 20, 2021
vincepri
vincepri reviewed Jul 20, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
vincepri
vincepri reviewed Jul 20, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
vincepri
vincepri reviewed Jul 20, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@vincepri
Copy link
Member

@mig4 Do you have some time to address the comments above?

@mig4
Copy link
Contributor Author

mig4 commented Aug 5, 2021

@mig4 Do you have some time to address the comments above?

Sorry, hope you don't mind the delays, I get pulled into various projects. But yeah, I'm on it 😄

@mig4 @vincepri
Fix wording
5f9e7e0 
Co-authored-by: Vince Prignano <vince@vincepri.com>
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 5, 2021
@mig4
Copy link
Contributor Author

mig4 commented Aug 5, 2021

Let me know if this is fine and I'll squash again.

@stmcginnis
Copy link
Contributor

/lgtm

I think it should be good to squash. I have a couple of very trivial nits, but I don't think they are even worth pointing out and possibly holding this up any longer. This would be very nice content to get added.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 30, 2021
stmcginnis
stmcginnis reviewed Sep 4, 2021
View reviewed changes
Copy link
Contributor

@stmcginnis stmcginnis left a comment •
edited
Loading

Choose a reason for hiding this comment

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

/lgtm

Formatting looks fine and all links checked out for me. I agree, I think we're ready to squash the changes, then should be good to go. Thanks!

(and now I notice I had already reviewed this a few days ago - still looks good :D )

vincepri
vincepri approved these changes Sep 8, 2021
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 8, 2021
@k8s-ci-robot k8s-ci-robot merged commit 494b8cc into kubernetes-sigs:master Sep 8, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Sep 8, 2021
@mig4 mig4 deleted the contributing-docs-note branch October 23, 2021 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@mrajashree mrajashree mrajashree left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@sbueringer sbueringer sbueringer left review comments

@stmcginnis stmcginnis stmcginnis left review comments

@vincepri vincepri vincepri approved these changes

@CecileRobertMichon CecileRobertMichon Awaiting requested review from CecileRobertMichon

@justinsb justinsb Awaiting requested review from justinsb

Assignees

@stmcginnis stmcginnis

@sbueringer sbueringer

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
v0.4
Development

Successfully merging this pull request may close these issues.
8 participants
@mig4 @k8s-ci-robot @fabriziopandini @sftim @sbueringer @vincepri @stmcginnis @mrajashree