search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.44k stars 14.32k forks source link

Migrate volume snapshot tasks to Tasks section #32785

Open sftim opened 2 years ago

sftim commented 2 years ago

This is a refactor request

What would you like to be added Create a new task page that contains the task-like content relating to snapshots, such as Create a PersistentVolumeClaim from a Volume Snapshot. It's OK to create more than one page if you need to.

You should not need to write new content or change the existing content.

Make sure that the concept page for PersistentVolume hyperlinks to any pages that you create as part of this work.

Why is this needed The concept page is plenty big, and the snapshot tasks are hard to isolate from the rest of the text. When readers want to perform specific tasks, it helps if there is page that walks through the steps to follow without diversions.

Comments Add the refactor label to any pull request this makes a change, or flag to your review that that label is needed. /language en

It's OK to address this issue through multiple pull requests. Mention me (@sftim) if you are working on this and would like help with the work - you can comment on this issue with your query. The wider Documentation SIG will also be available to offer tips.

sftim commented 2 years ago

Remember to update https://kubernetes.io/docs/concepts/storage/volume-snapshots/ if you make any relevant changes.

Kartik494 commented 2 years ago

/sig storage

mehabhalodiya commented 2 years ago

/triage accepted

Rishit-dagli commented 2 years ago

@sftim Are we eyeing at creating seperate pages, each for a task like:

and others? I personally believe a nice way would be to create 1-page with a list of all these tasks, I am still a bit confused about approaching this issue though.

k8s-triage-robot commented 2 years ago

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:

You can:

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

/lifecycle stale

Kartik494 commented 2 years ago

/remove-lifecycle stale

sftim commented 2 years ago

@sftim Are we eyeing at creating seperate pages, each for a task like:

* https://kubernetes.io/docs/concepts/storage/persistent-volumes/#create-persistent-volume-claim-from-an-existing-pvc

* https://kubernetes.io/docs/concepts/storage/persistent-volumes/#create-persistent-volume-claim-from-volume-snapshot

* https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistent-volume-claim-requesting-a-raw-block-volume

* https://kubernetes.io/docs/concepts/storage/persistent-volumes/#pod-specification-adding-raw-block-device-path-in-container

and others? I personally believe a nice way would be to create 1-page with a list of all these tasks, I am still a bit confused about approaching this issue though.

I don't have a strong view on whether that should be one page or several. @Rishit-dagli if you want to do it as one page I think that sounds fine - it's an improvement on what we have now.

k8s-triage-robot commented 1 year ago

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:

You can:

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

/lifecycle stale

k8s-triage-robot commented 1 year ago

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:

You can:

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

/lifecycle rotten

Kartik494 commented 1 year ago

/remove-lifecycle rotten

sftim commented 1 year ago

Help on this issue is welcome.

k8s-triage-robot commented 1 month ago

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted