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

Improve Volumes concept page (including diagram?) #31159

Closed
JoeKuan opened this issue Dec 31, 2021 · 26 comments
Closed

Improve Volumes concept page (including diagram?) #31159

JoeKuan opened this issue Dec 31, 2021 · 26 comments
Labels
language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. sig/storage Categorizes an issue or PR as relevant to SIG Storage. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@JoeKuan
Copy link

JoeKuan commented Dec 31, 2021

For beginners with little knowledge of k8, the Volumes should just give a very general picture of managing storage, instead the concept page gives a long list of different type of volumes which most beginners don't really need at this point.

The PV in Static and Dynamic provisioning should be presented with a diagram to illustrate the significance and how different are them.

Basically, I have to rely on external sources to understand volumes in k8 rather than the concept page. IMHO, when it comes to concept, always pictures than words.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Dec 31, 2021
@sftim sftim mentioned this issue Jan 1, 2022
2 tasks
@sftim
Copy link
Contributor

sftim commented Jan 3, 2022

/sig storage

@k8s-ci-robot k8s-ci-robot added the sig/storage Categorizes an issue or PR as relevant to SIG Storage. label Jan 3, 2022
@Kartik494
Copy link
Contributor

For beginners with little knowledge of k8, the Volumes should just give a very general picture of managing storage, instead the concept page gives a long list of different type of volumes which most beginners don't really need at this point.

Hi @JoeKuan Could you please elaborate how do you want to implement this part ? I think added some description would be great? is anyone working on this issue

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 21, 2022
@Kartik494
Copy link
Contributor

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 23, 2022
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 21, 2022
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Oct 21, 2022
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

@k8s-ci-robot
Copy link
Contributor

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@network-charles
Copy link
Contributor

@sftim, I'd like to work on this issue. Let me know what you think about my suggestions.

From the below comment, the volume page indeed lacks an introduction to what a volume is. Instead, it went ahead and talked about the problem a volume solves.
I can add a brief introduction to what a volume is.

For beginners with little knowledge of k8, the Volumes should just give a very general picture of managing storage, instead the concept page gives a long list of different type of volumes which most beginners don't really need at this point.
Page: https://kubernetes.io/docs/concepts/storage/volumes/

I'd also like to ask a question about another comment from the contributor who opened the issue.

The PV in Static and Dynamic provisioning should be presented with a diagram to illustrate the significance and how different are them.
Page: https://kubernetes.io/docs/concepts/storage/persistent-volumes/

I'm not sure how I should represent the diagram, as per the diagram guide. Below is a rough sketch of what I plan to do.

Screenshot 2024-12-18 at 11 56 09 AM

@sftim
Copy link
Contributor

sftim commented Dec 18, 2024

We can't plagiarize the diagram in https://medium.com/devops-mojo/kubernetes-storage-options-overview-persistent-volumes-pv-claims-pvc-and-storageclass-sc-k8s-storage-df71ca0fccc3 but that is more the kind of thing I'd expect to see.

PS this issue is marked as Closed. Do you want it reopened @network-charles ?

@network-charles
Copy link
Contributor

Yes, I’d like it reopened.

Ah, I have a similar diagram to that here. You are referring to something like that, right?

@sftim
Copy link
Contributor

sftim commented Dec 18, 2024

/reopen

/retitle Improve Volumes concept page (including diagram?)

@k8s-ci-robot k8s-ci-robot changed the title Improvement for k8s.io/docs/concepts/storage/volumes/ Improve Volumes concept page (including diagram?) Dec 18, 2024
@k8s-ci-robot
Copy link
Contributor

@sftim: Reopened this issue.

In response to this:

/reopen

/retitle Improve Volumes concept page (including diagram?)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot reopened this Dec 18, 2024
@sftim
Copy link
Contributor

sftim commented Dec 18, 2024

/language en
/remove-lifecycle rotten
/triage accepted
/priority backlog

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Dec 18, 2024
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 18, 2024
@network-charles
Copy link
Contributor

@sftim, what do you think about these new diagrams for the static and dynamic volumes?
Screenshot 2024-12-20 at 4 27 16 PM

@sftim
Copy link
Contributor

sftim commented Dec 20, 2024

[I'm happy to let anyone do review here]

@sftim
Copy link
Contributor

sftim commented Dec 20, 2024

/uncc

@network-charles
Copy link
Contributor

Alright

@sftim
Copy link
Contributor

sftim commented Jan 13, 2025

See #49154

@sftim
Copy link
Contributor

sftim commented Jan 13, 2025

Closing in favor of #49419

@sftim
Copy link
Contributor

sftim commented Jan 13, 2025

/close

@k8s-ci-robot
Copy link
Contributor

@sftim: Closing this issue.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@sftim
Copy link
Contributor

sftim commented Jan 13, 2025

Oops.
/reopen

@k8s-ci-robot k8s-ci-robot reopened this Jan 13, 2025
@k8s-ci-robot
Copy link
Contributor

@sftim: Reopened this issue.

In response to this:

Oops.
/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@sftim
Copy link
Contributor

sftim commented Jan 13, 2025

/close not-planned

@k8s-ci-robot k8s-ci-robot closed this as not planned Won't fix, can't repro, duplicate, stale Jan 13, 2025
@k8s-ci-robot
Copy link
Contributor

@sftim: Closing this issue, marking it as "Not Planned".

In response to this:

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. sig/storage Categorizes an issue or PR as relevant to SIG Storage. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

6 participants