-
Notifications
You must be signed in to change notification settings - Fork 14
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
update Readme and fix couple of spilling errors #12
Conversation
9341b6c
to
62ff6b3
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12 +/- ##
===========================================
- Coverage 43.82% 26.38% -17.44%
===========================================
Files 18 75 +57
Lines 1716 5021 +3305
===========================================
+ Hits 752 1325 +573
- Misses 846 3532 +2686
- Partials 118 164 +46
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
62ff6b3
to
c9417de
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some small nits
README.md
Outdated
[![Project maturity: alpha](https://img.shields.io/badge/maturity-alpha-orange.svg)]() | ||
[![Go report card](https://goreportcard.com/badge/github.com/bpfman/bpfman-operator)](https://goreportcard.com/report/github.com/bpfman/bpfman-operator) | ||
|
||
## Deploy bpfman Operation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Deploy bpfman Operation | |
## Deploy bpfman Operator |
README.md
Outdated
make run-on-kind | ||
``` | ||
|
||
>> **NOTE:** By default, bpfman-operator deploys bpfman with CSI enabled. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
>> **NOTE:** By default, bpfman-operator deploys bpfman with CSI enabled. | |
> **NOTE:** By default, bpfman-operator deploys bpfman with CSI enabled. |
README.md
Outdated
make deploy-openshift | ||
``` | ||
|
||
To clean up at a later, run: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To clean up at a later, run: | |
To clean up at a later time, run: |
README.md
Outdated
First set up the namespace and certificates for the operator with: | ||
|
||
```bash | ||
oc apply -f ./hack/ocp-scc-hacks.yaml | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First set up the namespace and certificates for the operator with: | |
```bash | |
oc apply -f ./hack/ocp-scc-hacks.yaml | |
``` | |
First create the namespace: | |
```bash | |
oc create ns openshift-bpfman |
README.md
Outdated
followed by | ||
|
||
```bash | ||
oc delete -f ./hack/ocp-scc-hacks.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oc delete -f ./hack/ocp-scc-hacks.yaml | |
oc delete ns openshift-bpfman |
Signed-off-by: Mohamed Mahmoud <mmahmoud@redhat.com>
c9417de
to
fc6669a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
update readme and fix typos to imporve go report card