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.

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

Enhance documentation #318

Merged
merged 1 commit into from
Mar 7, 2022
Merged

Conversation

0xFelix
Copy link
Member

@0xFelix 0xFelix commented Mar 2, 2022

What this PR does / why we need it:

Enhance documentation by adding resource type / CRD requirements to
README.md and by moving developers documentation to docs/development.md and
expanding it.

Release note:

None

@kubevirt-bot kubevirt-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Mar 2, 2022
@openshift-ci
Copy link

openshift-ci bot commented Mar 2, 2022

Hi @0xFelix. Thanks for your PR.

I'm waiting for a kubevirt 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.

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 2, 2022
@0xFelix
Copy link
Member Author

0xFelix commented Mar 2, 2022

/cc @lyarwood
/cc @geetikakay
/cc @akrejcir
/cc @dominikholler

@kubevirt-bot
Copy link
Contributor

@0xFelix: GitHub didn't allow me to request PR reviews from the following users: geetikakay, lyarwood.

Note that only kubevirt members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @lyarwood
/cc @geetikakay
/cc @akrejcir
/cc @dominikholler

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.

Copy link
Member

@lyarwood lyarwood left a comment

Choose a reason for hiding this comment

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

LGTM assuming others are okay with this being in the main README as opposed to a separate contributor or devel doc somewhere?

@kubevirt-bot
Copy link
Contributor

@lyarwood: changing LGTM is restricted to collaborators

In response to this:

LGTM assuming others are okay with this being in the main README as opposed to a separate contributor or devel doc somewhere?

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.

@akrejcir
Copy link
Collaborator

akrejcir commented Mar 7, 2022

@0xFelix Can you please move info for developers to a separate file? It was ok to keep it in README.md when it was small, but now there is a lot of developer info.

Enhance documentation by adding resource type / CRD requirements to
README.md and by moving developers documentation to docs/development.md and
expanding it.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
@sonarcloud
Copy link

sonarcloud bot commented Mar 7, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@0xFelix 0xFelix changed the title Enhance README.md Enhance documentation Mar 7, 2022
@0xFelix
Copy link
Member Author

0xFelix commented Mar 7, 2022

@akrejcir Done as requested

@akrejcir
Copy link
Collaborator

akrejcir commented Mar 7, 2022

Thanks.

/lgtm
/approve
/ok-to-test

@kubevirt-bot kubevirt-bot 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 7, 2022
@kubevirt-bot kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Mar 7, 2022
@kubevirt-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: akrejcir

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

@kubevirt-bot kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 7, 2022
@akrejcir
Copy link
Collaborator

akrejcir commented Mar 7, 2022

/override ci/prow/e2e-functests
/override ci/prow/e2e-single-node-functests
/override ci/prow/e2e-upgrade-functests

@kubevirt-bot
Copy link
Contributor

@akrejcir: Overrode contexts on behalf of akrejcir: ci/prow/e2e-functests, ci/prow/e2e-single-node-functests, ci/prow/e2e-upgrade-functests

In response to this:

/override ci/prow/e2e-functests
/override ci/prow/e2e-single-node-functests
/override ci/prow/e2e-upgrade-functests

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.

@kubevirt-bot kubevirt-bot merged commit 63719b1 into kubevirt:master Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. lgtm 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. release-note-none Denotes a PR that doesn't merit a release note. size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants