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

Documentation Refresh #244

Merged
merged 5 commits into from
Mar 4, 2020
Merged

Documentation Refresh #244

merged 5 commits into from
Mar 4, 2020

Conversation

seanmalloy
Copy link
Member

This pull requests cleans up the README.md file, creates a user guide, and creates a contributor guide. The user and contributor guides could use some additional improvements, but I believe in their current state will provide value to end users.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 26, 2020
@seanmalloy
Copy link
Member Author

/assign @aveshagarwal @damemi

ingvagabund
ingvagabund reviewed Feb 27, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@seanmalloy
Copy link
Member Author

@ingvagabund thanks for the review! I addressed all of your review comments. Please review again when you have some time.

ingvagabund
ingvagabund requested changes Mar 2, 2020
View reviewed changes
Copy link
Contributor

@ingvagabund ingvagabund left a comment

Choose a reason for hiding this comment

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

@seanmalloy thanks for addressing the comments. Found two small nits. Otherwise, lgtm.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@seanmalloy
Copy link
Member Author

@ingvagabund I fixed that last two review comments. Let me know if you find anything else. Thanks!

@ingvagabund
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 4, 2020
@seanmalloy
Copy link
Member Author

@ravisantoshgudimetla and @aveshagarwal please review when you have some time.

@aveshagarwal
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aveshagarwal, seanmalloy

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 Mar 4, 2020
@k8s-ci-robot k8s-ci-robot merged commit 2545c8b into kubernetes-sigs:master Mar 4, 2020
@seanmalloy seanmalloy deleted the docs-revamp branch March 4, 2020 15:23
@seanmalloy seanmalloy mentioned this pull request May 20, 2020
Closed
4 tasks
briend pushed a commit to briend/descheduler that referenced this pull request Feb 11, 2022
Merge pull request kubernetes-sigs#244 from KohlsTechnology/docs-revamp
bb39968 
Documentation Refresh
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ingvagabund ingvagabund ingvagabund requested changes

@aveshagarwal aveshagarwal Awaiting requested review from aveshagarwal

@damemi damemi Awaiting requested review from damemi

Assignees

@damemi damemi

@aveshagarwal aveshagarwal

@ingvagabund ingvagabund

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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@seanmalloy @ingvagabund @aveshagarwal @k8s-ci-robot @damemi