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

docs: move bpfman-operator details from README to docs #366

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Billy99
Copy link
Contributor

@Billy99 Billy99 commented Jan 28, 2025

The bpfman-operator README.md contained operator details that belonged in the general docs. Move this content to the docs, and expand on the details where needed. Also update the bpfman-operator README to be closer to the bpfman README by adding the bpfman logo, CNCF logo, some of the relavent badges, and the star history.

Related: bpfman/bpfman#1388

Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 28, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.12%. Comparing base (afdc19a) to head (217dce8).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #366   +/-   ##
=======================================
  Coverage   28.12%   28.12%           
=======================================
  Files         128      128           
  Lines       11207    11207           
=======================================
  Hits         3152     3152           
  Misses       7773     7773           
  Partials      282      282           
Flag Coverage Δ
unittests 28.12% <ø> (ø)

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.

@Billy99 Billy99 force-pushed the billy99-doc-operator-devel branch 3 times, most recently from 721b3dd to a409380 Compare January 28, 2025 16:36
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed. Also update the bpfman-operator README to be
closer to the bpfman README by adding the bpfman logo, CNCF logo,
some of the relavent badges, and the star history.

Signed-off-by: Billy McFall <[email protected]>
@Billy99 Billy99 force-pushed the billy99-doc-operator-devel branch from a409380 to 217dce8 Compare January 28, 2025 16:57
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged
in the general docs. Move this content to the docs, and expand on the
details where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
Billy99 added a commit to Billy99/bpfman that referenced this pull request Jan 29, 2025
The bpfman-operator README.md contained operator details that belonged in
the general docs. Move this content to the docs, and expand on the details
where needed.

Related: bpfman/bpfman-operator#366

Signed-off-by: Billy McFall <[email protected]>
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.

1 participant