Skip to content

docs: refactor kubernetes documentation#1385

Draft
lukasmetzner wants to merge 14 commits into
mainfrom
docs-refactor-diataxis
Draft

docs: refactor kubernetes documentation#1385
lukasmetzner wants to merge 14 commits into
mainfrom
docs-refactor-diataxis

Conversation

@lukasmetzner
Copy link
Copy Markdown
Contributor

@lukasmetzner lukasmetzner commented Jun 1, 2026

Refactors the csi-driver documentation to align with https://diataxis.fr.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.17%. Comparing base (22f4b1a) to head (e67ef5d).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1385      +/-   ##
==========================================
+ Coverage   71.97%   72.17%   +0.19%     
==========================================
  Files          17       17              
  Lines        1520     1520              
==========================================
+ Hits         1094     1097       +3     
+ Misses        338      336       -2     
+ Partials       88       87       -1     
Flag Coverage Δ
e2e-controller 56.90% <ø> (+0.19%) ⬆️
e2e-node 56.90% <ø> (+0.19%) ⬆️
integration 3.19% <ø> (ø)
unit 40.85% <ø> (ø)

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.

@lukasmetzner lukasmetzner changed the title docs: move to diataxis docs: refactor kubernetes documentation Jun 2, 2026
@lukasmetzner lukasmetzner marked this pull request as ready for review June 2, 2026 06:33
@lukasmetzner lukasmetzner requested a review from a team as a code owner June 2, 2026 06:33
Copy link
Copy Markdown
Member

@jooola jooola left a comment

Choose a reason for hiding this comment

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

Did a first pass, thanks for pushing for this ❤️!

Comment thread docs/kubernetes/guides/quickstart.md Outdated
Comment thread docs/kubernetes/guides/quickstart.md Outdated
Comment thread docs/kubernetes/guides/troubleshooting.md Outdated
Comment thread docs/kubernetes/reference/xfs-filesystem.md
@@ -0,0 +1,84 @@
# Quick start
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd argue this is a tutorial, but I don't mind having it as guide.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I shortened it a bit in 9eb7706.

I also think it is not a good idea to have a PVC example creation there, as this directly introduces some costs to the customer. Verifying the StorageClass should be fine. Folks should be familiar with creating a PVC from a StorageClass.

@lukasmetzner lukasmetzner force-pushed the docs-refactor-diataxis branch from 4aec23f to 9da3655 Compare June 2, 2026 07:38
@lukasmetzner lukasmetzner marked this pull request as draft June 2, 2026 10:39
@lukasmetzner
Copy link
Copy Markdown
Contributor Author

I want to add a few more things here.

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