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

update Readme and fix couple of spilling errors #12

Merged
merged 1 commit into from
Jun 3, 2024

Conversation

msherif1234
Copy link
Contributor

update readme and fix typos to imporve go report card

@msherif1234 msherif1234 force-pushed the update-readme branch 2 times, most recently from 9341b6c to 62ff6b3 Compare June 2, 2024 12:02
Copy link

codecov bot commented Jun 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 26.38%. Comparing base (7f71813) to head (fc6669a).
Report is 12 commits behind head on main.

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     
Flag Coverage Δ
unittests 26.38% <ø> (-17.44%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@astoycos astoycos left a 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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Deploy bpfman Operation
## Deploy bpfman Operator

README.md Outdated
make run-on-kind
```

>> **NOTE:** By default, bpfman-operator deploys bpfman with CSI enabled.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
>> **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:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To clean up at a later, run:
To clean up at a later time, run:

README.md Outdated
Comment on lines 63 to 67
First set up the namespace and certificates for the operator with:

```bash
oc apply -f ./hack/ocp-scc-hacks.yaml
```
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
oc delete -f ./hack/ocp-scc-hacks.yaml
oc delete ns openshift-bpfman

Signed-off-by: Mohamed Mahmoud <mmahmoud@redhat.com>
Copy link
Member

@astoycos astoycos left a comment

Choose a reason for hiding this comment

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

LGTM

@astoycos astoycos merged commit 529333a into bpfman:main Jun 3, 2024
4 of 5 checks passed
msherif1234 added a commit to msherif1234/bpfman-operator that referenced this pull request Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants