Skip to content

docs: explain csi driver architecture and restructure docs#1268

Merged
lukasmetzner merged 2 commits intodocs-explain-sidecarsfrom
docs-restructure-kubernetes-docs
Feb 26, 2026
Merged

docs: explain csi driver architecture and restructure docs#1268
lukasmetzner merged 2 commits intodocs-explain-sidecarsfrom
docs-restructure-kubernetes-docs

Conversation

@lukasmetzner
Copy link
Copy Markdown
Contributor

This is not yet a move to https://diataxis.fr/.

I mainly want to have some sort of indexing for the two documents how-to-import-volumes.md and csi-driver-architecture.md. This is currently hard to do nicely, as all our k8s docs are in one big README.md. For this reason, I moved all level two headings of the Kubernetes README.md into separate files. The content was not edited.

Additionally, I restructured the root README.md a bit to be more consistent with other k8s repositories.

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.59%. Comparing base (ab67865) to head (eb42015).

Additional details and impacted files
@@                    Coverage Diff                    @@
##           docs-explain-sidecars    #1268      +/-   ##
=========================================================
+ Coverage                  71.52%   71.59%   +0.06%     
=========================================================
  Files                         17       17              
  Lines                       1475     1475              
=========================================================
+ Hits                        1055     1056       +1     
+ Misses                       334      333       -1     
  Partials                      86       86              
Flag Coverage Δ
e2e-controller 56.61% <ø> (+0.06%) ⬆️
e2e-node 56.61% <ø> (+0.06%) ⬆️
integration 3.31% <ø> (ø)
unit 40.94% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@apricote apricote left a comment

Choose a reason for hiding this comment

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

Looks good besides the one comment. I did not verify if the content of the split up pages equals the old content.

Comment thread README.md
@lukasmetzner lukasmetzner merged commit 00fa022 into docs-explain-sidecars Feb 26, 2026
10 checks passed
@lukasmetzner lukasmetzner deleted the docs-restructure-kubernetes-docs branch February 26, 2026 09:30
lukasmetzner added a commit that referenced this pull request Feb 26, 2026
This document is currently not indexed anywhere in our docs. So there is
#1268 to address this in a separate PR.
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