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: add overview and migrate existing to github #1805

Merged
merged 3 commits into from
Jan 30, 2025
Merged

Conversation

tiagolobocastro
Copy link
Contributor

@tiagolobocastro tiagolobocastro commented Jan 22, 2025

feat: parse human size for malloc and null bdevs

Parse a size with unit post-fix for the malloc and null bdevs.
This makes it much easier to use, example:
size=1TiB vs size_mb=1048576

Signed-off-by: Tiago Castro <[email protected]>

docs: move older design docs into the git repo

Signed-off-by: Tiago Castro <[email protected]>

docs: add overview for arch and improve csi

Adds an overview png for the README
Improves slight CSI wording and adds a CSI diagram

Signed-off-by: Tiago Castro <[email protected]>

README.md Outdated Show resolved Hide resolved
doc/csi.md Show resolved Hide resolved
doc/csi.md Show resolved Hide resolved
doc/img/overview.drawio.png Outdated Show resolved Hide resolved
doc/design/control-plane-behaviour.md Outdated Show resolved Hide resolved
doc/design/control-plane-behaviour.md Outdated Show resolved Hide resolved
doc/design/control-plane-behaviour.md Outdated Show resolved Hide resolved
doc/design/control-plane-behaviour.md Outdated Show resolved Hide resolved
doc/design/control-plane-behaviour.md Outdated Show resolved Hide resolved
doc/design/k8s/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/design/k8s/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/design/k8s/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/design/k8s/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/design/k8s/kubectl-plugin.md Outdated Show resolved Hide resolved
Parse a size with unit post-fix for the malloc and null bdevs.
This makes it much easier to use, example:
size=1TiB vs size_mb=1048576

Signed-off-by: Tiago Castro <[email protected]>
Adds an overview png for the README
Improves slight CSI wording and adds a CSI diagram

Signed-off-by: Tiago Castro <[email protected]>
@tiagolobocastro tiagolobocastro force-pushed the docs branch 8 times, most recently from 77a7e88 to bf7169a Compare January 27, 2025 13:50
@tiagolobocastro
Copy link
Contributor Author

Could not get the images to display within the mermaid graph sadly :(

Copy link
Member

@sinhaashish sinhaashish left a comment

Choose a reason for hiding this comment

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

one last comment otherwise lgtm

doc/design/k8s/diskpool-cr.md Outdated Show resolved Hide resolved
@tiagolobocastro
Copy link
Contributor Author

bors merge

@bors-openebs-mayastor
Copy link

Build succeeded:

@bors-openebs-mayastor bors-openebs-mayastor bot merged commit 6cfdc89 into develop Jan 30, 2025
4 checks passed
@bors-openebs-mayastor bors-openebs-mayastor bot deleted the docs branch January 30, 2025 19:30
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.

3 participants