Updated formatting in "Persistent Volumes" & "Storage Classes" #19575

sujaypillai · 2020-03-09T18:14:03Z

Removed backticks from all occurrences of PersistentVolume, PersistentVolumeClaim and StorageClass.
Also update the page Storage Class with the same concept.

Fixes #19542

netlify · 2020-03-09T18:18:16Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit a7172e2

https://deploy-preview-19575--kubernetes-io-master-staging.netlify.com

sujaypillai · 2020-03-09T23:00:46Z

/assign @sftim

sftim

@sujaypillai that's good (and comprehensive) work.
Here's some feedback. Most of it is inline.

Also one specific thing:

check the section “A Note on Namespaces” - did you miss a couple of changes?

sftim · 2020-03-10T00:25:33Z

content/en/docs/concepts/storage/persistent-volumes.md

-ways than just size and access modes, without exposing users to the details of
-how those volumes are implemented. For these needs, there is the `StorageClass`
-resource.
+While `PersistentVolumeClaims` allow a user to consume abstract storage resources, it is common that users need `PersistentVolumes` with varying properties, such as performance, for different problems. Cluster administrators need to be able to offer a variety of `PersistentVolumes` that differ in more ways than just size and access modes, without exposing users to the details of how those volumes are implemented. For these needs, there is the StorageClass resource.


Suggested change

While `PersistentVolumeClaims` allow a user to consume abstract storage resources, it is common that users need `PersistentVolumes` with varying properties, such as performance, for different problems. Cluster administrators need to be able to offer a variety of `PersistentVolumes` that differ in more ways than just size and access modes, without exposing users to the details of how those volumes are implemented. For these needs, there is the StorageClass resource.

While PersistentVolumeClaims allow a user to consume abstract storage resources, it is common that users need PersistentVolumes with varying properties, such as performance, for different problems. Cluster administrators need to be able to offer a variety of PersistentVolumes that differ in more ways than just size and access modes, without exposing users to the details of how those volumes are implemented. For these needs, there is the _StorageClass_ resource.

sftim · 2020-03-10T00:25:47Z

content/en/docs/concepts/storage/persistent-volumes.md

@@ -55,7 +49,7 @@ A cluster administrator creates a number of PVs. They carry the details of the r

 #### Dynamic

-When none of the static PVs the administrator created match a user's `PersistentVolumeClaim`,
+When none of the static PVs the administrator created match a user's PersistentVolumeClaim,
 the cluster may try to dynamically provision a volume specially for the PVC.
 This provisioning is based on `StorageClasses`: the PVC must request a


Suggested change

This provisioning is based on `StorageClasses`: the PVC must request a

This provisioning is based on StorageClasses: the PVC must request a

sftim · 2020-03-10T00:28:38Z

content/en/docs/concepts/storage/persistent-volumes.md

@@ -80,10 +74,10 @@ Claims will remain unbound indefinitely if a matching volume does not exist. Cla

 Pods use claims as volumes. The cluster inspects the claim to find the bound volume and mounts that volume for a Pod. For volumes that support multiple access modes, the user specifies which mode is desired when using their claim as a volume in a Pod.

-Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a `persistentVolumeClaim` in their Pod's volumes block. [See below for syntax details](#claims-as-volumes).
+Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a persistentVolumeClaim in their Pod's volumes block. [See below for syntax details](#claims-as-volumes).


This would actually work better as:

Suggested change

Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a persistentVolumeClaim in their Pod's volumes block. [See below for syntax details](#claims-as-volumes).

Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a `persistentVolumeClaim` section in a Pod's `volumes` block. See [Claims As Volumes](#claims-as-volumes) for more details on this.

sftim · 2020-03-10T00:29:24Z

content/en/docs/concepts/storage/persistent-volumes.md

@@ -228,7 +222,7 @@ Support for expanding CSI volumes is enabled by default but it also requires a s
 You can only resize volumes containing a file system if the file system is XFS, Ext3, or Ext4.

 When a volume contains a file system, the file system is only resized when a new Pod is using
-the `PersistentVolumeClaim` in ReadWrite mode. File system expansion is either done when a Pod is starting up
+the PersistentVolumeClaim in ReadWrite mode. File system expansion is either done when a Pod is starting up


nit:

Suggested change

the PersistentVolumeClaim in ReadWrite mode. File system expansion is either done when a Pod is starting up

the PersistentVolumeClaim in `ReadWrite` mode. File system expansion is either done when a Pod is starting up

sftim · 2020-03-10T00:31:24Z

content/en/docs/concepts/storage/persistent-volumes.md

@@ -578,7 +572,7 @@ Only FC and iSCSI volumes supported raw block volumes in Kubernetes 1.9.
 Support for the additional plugins was added in 1.10.
 {{< /note >}}

-### Persistent Volumes using a Raw Block Volume
+### PersistentVolume using a Raw Block Volume


To keep incoming links working, do this:

Suggested change

### PersistentVolume using a Raw Block Volume

### PersistentVolume using a Raw Block Volume {#persistent-volume-using-a-raw-block-volume}

sftim · 2020-03-10T00:35:02Z

content/en/docs/concepts/storage/storage-classes.md

@@ -219,7 +219,7 @@ allowedTopologies:

 ## Parameters

-Storage classes have parameters that describe volumes belonging to the storage
+Storage Classes have parameters that describe volumes belonging to the storage


Suggested change

Storage Classes have parameters that describe volumes belonging to the storage

StorageClasses have parameters that describe volumes belonging to the storage

sftim · 2020-03-10T00:35:15Z

content/en/docs/concepts/storage/storage-classes.md

@@ -367,7 +367,7 @@ parameters:
  `"8452344e2becec931ece4e33c4674e4e,42982310de6c63381718ccfa6d8cf397"`. This
  is an optional parameter.
 * `gidMin`, `gidMax` : The minimum and maximum value of GID range for the
-  storage class. A unique value (GID) in this range ( gidMin-gidMax ) will be
+  StorageClass. A unique value (GID) in this range ( gidMin-gidMax ) will be


Fine; the original is also OK.

sftim · 2020-03-10T00:36:13Z

content/en/docs/concepts/storage/storage-classes.md

@@ -580,7 +580,7 @@ parameters:

 ### Azure Disk

-#### Azure Unmanaged Disk Storage Class
+#### Azure Unmanaged Disk StorageClass


I'd write:

Suggested change

#### Azure Unmanaged Disk StorageClass

#### Azure Unmanaged Disk storage class

content/en/docs/concepts/storage/storage-classes.md

sftim

@sujaypillai, could you also look at line 19 of content/en/docs/concepts/storage/persistent-volumes.md?

sftim · 2020-03-11T01:01:01Z

I think with maybe one more tweak this will be done.

sftim

Two small nits and one regression I think is definitely worth fixing (missing “See ” from a link)

content/en/docs/concepts/storage/persistent-volumes.md

content/en/docs/concepts/storage/storage-classes.md

content/en/docs/concepts/storage/persistent-volumes.md

jimangel · 2020-03-16T03:51:46Z

content/en/docs/concepts/storage/persistent-volumes.md

@@ -300,7 +294,7 @@ spec:
    storage: 5Gi
  volumeMode: Filesystem
  accessModes:
-    - ReadWriteOnce
+    - `Once


Is this correct? The backticks here appear unnecessary.

and there is no access mode called ReadWriteOnce.

tengqm · 2020-03-16T04:15:59Z

content/en/docs/concepts/storage/persistent-volumes.md


 The access modes are:

-* ReadWriteOnce -- the volume can be mounted as read-write by a single node
+* `Once -- the volume can be mounted as read-write by a single node


Looks like these are nits introduced by a global replace operation. Please change it back.

jimangel · 2020-03-16T14:39:05Z

/lgtm

sftim · 2020-03-26T02:25:40Z

/approve

noting that Prow will squash these commits

k8s-ci-robot · 2020-03-26T02:25:57Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [sftim]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

…netes#19575) * Updated formatting in "Persistent Volumes" & "Storage Classes" * Ammended the suggestions * Amended changes after PR review * Ammended the suggestions * Ammended the suggestions * Amended changes

Updated formatting in "Persistent Volumes" & "Storage Classes"

1107495

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 9, 2020

k8s-ci-robot requested review from saad-ali and thockin March 9, 2020 18:14

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 9, 2020

k8s-ci-robot assigned sftim Mar 9, 2020

sftim requested changes Mar 10, 2020

View reviewed changes

Ammended the suggestions

f8a7dfc

sftim reviewed Mar 11, 2020

View reviewed changes

Amended changes after PR review

1b8ef21

sftim requested changes Mar 12, 2020

View reviewed changes

content/en/docs/concepts/storage/persistent-volumes.md Outdated Show resolved Hide resolved

content/en/docs/concepts/storage/storage-classes.md Outdated Show resolved Hide resolved

content/en/docs/concepts/storage/persistent-volumes.md Outdated Show resolved Hide resolved

sujaypillai added 2 commits March 13, 2020 07:35

Ammended the suggestions

89022a1

Ammended the suggestions

7fec491

jimangel reviewed Mar 16, 2020

View reviewed changes

tengqm reviewed Mar 16, 2020

View reviewed changes

Amended changes

a7172e2

k8s-ci-robot assigned jimangel Mar 16, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 26, 2020

k8s-ci-robot merged commit 7ebfafd into kubernetes:master Mar 26, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated formatting in "Persistent Volumes" & "Storage Classes" #19575

Updated formatting in "Persistent Volumes" & "Storage Classes" #19575

sujaypillai commented Mar 9, 2020

netlify bot commented Mar 9, 2020 •

edited

Loading

sujaypillai commented Mar 9, 2020

sftim left a comment

sftim Mar 10, 2020

sftim Mar 10, 2020

sftim Mar 10, 2020

sftim Mar 10, 2020

sftim Mar 10, 2020

sftim Mar 10, 2020

sftim Mar 10, 2020

sftim Mar 10, 2020

sftim left a comment

sftim commented Mar 11, 2020

sftim left a comment

jimangel Mar 16, 2020 •

edited

Loading

tengqm Mar 16, 2020

tengqm Mar 16, 2020

jimangel commented Mar 16, 2020

sftim commented Mar 26, 2020

k8s-ci-robot commented Mar 26, 2020

	This provisioning is based on `StorageClasses`: the PVC must request a
	This provisioning is based on StorageClasses: the PVC must request a

	Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a persistentVolumeClaim in their Pod's volumes block. [See below for syntax details](#claims-as-volumes).
	Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a `persistentVolumeClaim` section in a Pod's `volumes` block. See [Claims As Volumes](#claims-as-volumes) for more details on this.

	the PersistentVolumeClaim in ReadWrite mode. File system expansion is either done when a Pod is starting up
	the PersistentVolumeClaim in `ReadWrite` mode. File system expansion is either done when a Pod is starting up

	### PersistentVolume using a Raw Block Volume
	### PersistentVolume using a Raw Block Volume {#persistent-volume-using-a-raw-block-volume}

	Storage Classes have parameters that describe volumes belonging to the storage
	StorageClasses have parameters that describe volumes belonging to the storage

	#### Azure Unmanaged Disk StorageClass
	#### Azure Unmanaged Disk storage class

Updated formatting in "Persistent Volumes" & "Storage Classes" #19575

Updated formatting in "Persistent Volumes" & "Storage Classes" #19575

Conversation

sujaypillai commented Mar 9, 2020

netlify bot commented Mar 9, 2020 • edited Loading

sujaypillai commented Mar 9, 2020

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

sftim commented Mar 11, 2020

sftim left a comment

Choose a reason for hiding this comment

jimangel Mar 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimangel commented Mar 16, 2020

sftim commented Mar 26, 2020

k8s-ci-robot commented Mar 26, 2020

netlify bot commented Mar 9, 2020 •

edited

Loading

jimangel Mar 16, 2020 •

edited

Loading