docs: add overview and migrate existing to github #1805
+1,114
−61
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
tiagolobocastro
commented
Jan 22, 2025
•
tiagolobocastro
commented
tiagolobocastro
requested review from
sinhaashish,
Abhinandan-Purkait,
niladrih,
abhilashshetty04 and
dsharma-dc
tiagolobocastro
commented
Jan 22, 2025
tiagolobocastro
changed the title
This was referenced Jan 23, 2025
tiagolobocastro
force-pushed
the
docs
branch
8 times, most recently
from
01d75c2 to
d33e3fa
Compare
dsharma-dc
reviewed
Jan 27, 2025
There was a problem hiding this comment.
Shall we be showing linkages for control-plane agents and csi-node plugin? The ha-node-agent to csi-node one for example.
There was a problem hiding this comment.
Wanted this to be csi only, will add more complete diagram on another section later on
| PublicApi --> Rest | ||
| Rest --> |gRPC| InternalApi | ||
| InternalApi --> |gRPC| InternalServices | ||
| Node_1 <--> PublicApi |
There was a problem hiding this comment.
What does this csi-node to REST public API link represent? Where do we do that?
There was a problem hiding this comment.
It represents exactly that, we've had to do that to for one of the latest fixes on v2.7.2 unfortunately as the CSI volume context becomes stale and it's immutable so we can't modify it.
sinhaashish
reviewed
Jan 27, 2025
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
force-pushed
the
docs
branch
4 times, most recently
from
0e06a13 to
8dd7d67
Compare
tiagolobocastro
force-pushed
the
docs
branch
7 times, most recently
from
30f791b to
77a7e88
Compare
Signed-off-by: Tiago Castro <[email protected]>
|
Could not get the images to display within the mermaid graph sadly :( |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.