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

Update README to be more welcoming #172

Merged
merged 1 commit into from
Jan 26, 2023
Merged

Update README to be more welcoming #172

merged 1 commit into from
Jan 26, 2023

Conversation

ArangoGutierrez
Copy link
Contributor

@ArangoGutierrez ArangoGutierrez commented Jan 16, 2023 •
edited
Loading

This patch:

  • Updates the readme making it more welcoming and providing quick start instructions

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 16, 2023
@ArangoGutierrez
Copy link
Contributor Author

/assign marquiz

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 16, 2023
@ArangoGutierrez ArangoGutierrez added this to the v0.6.0 milestone Jan 17, 2023
marquiz
marquiz reviewed Jan 19, 2023
View reviewed changes
Copy link
Contributor

@marquiz marquiz left a comment

Choose a reason for hiding this comment

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

Thanks @ArangoGutierrez for the improvement. I had a few comments/suggestions.

One format-related wish (I think I mentioned that in some comment) is that please wrap the lines to some meaningful lenght (e.g. the standard 79/80 chars). Would make editing and also commenting a lot easier.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
SECURITY_CONTACTS Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
OWNERS Outdated Show resolved Hide resolved
@ArangoGutierrez ArangoGutierrez changed the title Update MD files Update README to be more welcoming Jan 23, 2023
marquiz
marquiz reviewed Jan 24, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@ArangoGutierrez
Copy link
Contributor Author

@marquiz PTAL :)

marquiz
marquiz approved these changes Jan 26, 2023
View reviewed changes
Copy link
Contributor

@marquiz marquiz left a comment

Choose a reason for hiding this comment

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

Thanks @ArangoGutierrez, let's merge this and improve deployment options later 😊
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 26, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ArangoGutierrez, marquiz

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 [ArangoGutierrez,marquiz]

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 merged commit f14f5a2 into kubernetes-sigs:master Jan 26, 2023
@ArangoGutierrez ArangoGutierrez mentioned this pull request Jan 30, 2023
Merged
@ArangoGutierrez ArangoGutierrez deleted the update_readme branch March 13, 2023 10:33
@ArangoGutierrez ArangoGutierrez mentioned this pull request Mar 14, 2023
Closed
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marquiz marquiz marquiz approved these changes

@zvonkok zvonkok Awaiting requested review from zvonkok

Assignees

@marquiz marquiz

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v0.6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@ArangoGutierrez @k8s-ci-robot @marquiz