Add NFS Volume Plugin Info to Docs #6192
Conversation
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project, in which case you'll need to sign a Contributor License Agreement (CLA) at https://cla.developers.google.com/. If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check the information on your CLA or see this help article on setting the email on your git commits. Once you've done that, please reply here to let us know. If you signed the CLA as a corporation, please let us know the company's name. |
|
CLA signed as part of Red Hat |
|
LGTM, thanks @wattsteve! Can we squash commits and we'll merge |
Update docs and example for NFS Plugin Modified the wording around how many Volumes exist Cleaned up the text around the NFS Pod description Fixed Spelling mistake on read-only
|
@vmarmol commits squashed |
vmarmol
added
the
lgtm
|
Thanks! We'll merge tomorrow when merge hours re-open. |
Add NFS Volume Plugin Info to Docs
Now that we have the NFS Volume Plugin committed, we need to edit the Volumes doc page to describe how to configure and use it. While the Plugin was committed with a pod file example,the example is minorly confusing in that it uses "nfs" as both the volume name and type. I've clarified this by renaming the name as "myshare" in the example, hence the inclusion of the example file in this PR.
Incidentally, the Volumes page is going to become an unnecessarily large if we include the pod example in-line with every plugin description. The NFS description links to the example file instead. I plan to follow this approach for the up-coming docs for Gluster File and Ceph Block.