kubernetes / kubernetes/website
Improvements to Storage concepts
- Dominant language
- HTML
- Stars
- 5.4k
- Forks
- 15.7k
- Avg merge
- 4d 18h
- Merged PRs (30d)
- 204
Description
**This is a Feature Request**
### What would you like to be added?
The work to do here is unusual. Rather than making pull requests, your first job is to make some more issues, about improvements to how we explain Kubernetes storage management.
_This_ issue is done when we have a set of issues opened that describe a series of approachable issues that each propose a useful improvement to storage concepts.
Aim to plan out the set of issues so that they are mostly settled before opening the first of those approachable, single-improvement-at-a-time issues.
### Why is this needed
The existing storage pages are not easy to understand, and the issues we have open are not very approachable.
We might:
- migrate some content to a tutorial page
- combine pages
- decide that we need to make a new task page
- define some reference pages, and open an issue for each reference page that needs adding
- add text into https://kubernetes.io/docs/concepts/storage/ (it is purely autogenerated at the time of writing)
:information_source: try not to directly work on PRs for this issue; instead, start on making a complete set of storage-related issues, _close this one off_ because it is done, and then work on each issue on turn.
### Selected existing Task pages
* [Limit Storage Consumption](https://kubernetes.io/docs/tasks/administer-cluster/limit-storage-consumption/)
* [Configure a Pod to Use a PersistentVolume for Storage](https://kubernetes.io/docs/tasks/configure-pod-container/configure-persistent-volume-storage/)
* [Configure a Pod to Use a Volume for Storage](https://kubernetes.io/docs/tasks/configure-pod-container/configure-volume-storage/)
* [Change the Access Mode of a PersistentVolume to ReadWriteOncePod](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-access-mode-readwriteoncepod/)
* [Configure a Pod to Use a Projected Volume for Storage](https://kubernetes.io/docs/tasks/configure-pod-container/configure-projected-volume-storage/)
Contributor guide
Research direction
Start by reviewing the existing storage concepts pages and the selected Task pages linked in the issue, including Limit Storage Consumption and the PersistentVolume, Volume, and Projected Volume guides. Map the documentation gaps and decide whether each needs migrated, combined, tutorial, task, or reference content. Done means opening a settled set of approachable, single-improvement storage issues rather than a pull request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100