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

Add a docs page for storage controller #7392

Merged
merged 3 commits into from Apr 18, 2024
Merged

Add a docs page for storage controller #7392

merged 3 commits into from Apr 18, 2024

Conversation

jcsp
Copy link
Contributor

@jcsp jcsp commented Apr 16, 2024

Problem

External contributors need information on how to use the storage controller.

Summary of changes

  • Background content on what the storage controller is.
  • Deployment information on how to use it.

This is not super-detailed, but should be enough for a well motivated third party to get started, with an occasional peek at the code.

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.
  • Do we need to implement analytics? if so did you add the relevant metrics to the dashboard?
  • If this PR requires public announcement, mark it with /release-notes label and add several sentences in this section.

Checklist before merging

  • Do not forget to reformat commit message to not include the above checklist

@jcsp jcsp added a/documentation Area: related to documentation c/storage/controller Component: Storage Controller labels Apr 16, 2024
Copy link

github-actions bot commented Apr 16, 2024

2766 tests run: 2648 passed, 0 failed, 118 skipped (full report)


Code coverage* (full report)

  • functions: 28.0% (6430 of 22994 functions)
  • lines: 46.6% (45226 of 97023 lines)

* collected from Rust tests only


The comment gets automatically updated with the latest test results
15b9703 at 2024-04-18T13:53:25.440Z :recycle:

@jcsp jcsp requested review from problame and VladLazar April 16, 2024 14:00
docs/storage_controller.md Outdated Show resolved Hide resolved
docs/storage_controller.md Outdated Show resolved Hide resolved
docs/storage_controller.md Outdated Show resolved Hide resolved
@jcsp jcsp enabled auto-merge (squash) April 18, 2024 13:08
@jcsp jcsp merged commit 0d8e680 into main Apr 18, 2024
48 checks passed
@jcsp jcsp deleted the jcsp/storcon-readme branch April 18, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a/documentation Area: related to documentation c/storage/controller Component: Storage Controller
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants