Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

Repo rename: markdown files update - part#4 [SKIP CI] #2040

Merged
merged 2 commits into from
Dec 15, 2017
Merged

Repo rename: markdown files update - part#4 [SKIP CI] #2040

merged 2 commits into from
Dec 15, 2017

Conversation

shuklanirdesh82
Copy link
Contributor

@shuklanirdesh82 shuklanirdesh82 commented Dec 13, 2017 •
edited
Loading

This part contains some of the action item for #2043

This PR contains changes related with repo name refreshing to "vSphere Storage for Docker".

  1. Update for README.md, CONTRIBUTING.md etc
  2. Update in customer facing document
  3. vDVS ===> VDVS (as we can't use small v)

@shuklanirdesh82 shuklanirdesh82 self-assigned this Dec 13, 2017
@shuklanirdesh82 shuklanirdesh82 force-pushed the readMeUpdate.shuklanirdesh82 branch 3 times, most recently from 90f6c74 to c53cfda Compare December 14, 2017 02:28
@shuklanirdesh82 shuklanirdesh82 changed the title Repo rename: markdown files update - part3 [SKIP CI] Repo rename: markdown files update - part#4 [SKIP CI] Dec 14, 2017
shaominchen
shaominchen reviewed Dec 14, 2017
View reviewed changes
Copy link
Contributor

@shaominchen shaominchen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like we are not consistent when to use the full name "vSphere Storage for Docker" and when to use the short name "VDVS". I'd suggest to use short time whenever it's being used as a modifier in a phrase, for example "VDVS driver", "VDVS plugin", "VDVS Installation Guide", etc.

README.md Outdated
@@ -47,7 +47,7 @@ The relevant logging for debugging consists of the following:
journalctl -fu docker.service # Journalctl/Systemd
```

**vDVS Plugin logs**
**vSphere Storage Plugin for Docker logs**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, let's use "VDVS Plugin logs"

README.md Outdated
@@ -74,14 +74,14 @@ journalctl -fu docker.service # Journalctl/Systemd
docker plugin install --grant-all-permissions --alias vsphere vmware/docker-volume-vsphere:latest VDVS_LOG_LEVEL=debug VDVS_SOCKET_GID=<group name>
```

**vDVS Driver logs**
**vSphere Storage Driver for Docker logs**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, let's use "VDVS Driver logs".

README.md Outdated

vSphere Docker Volume Service (vDVS) enables customers to address persistent storage requirements for Docker containers in vSphere environments. This service is integrated with [Docker Volume Plugin framework](https://docs.docker.com/engine/extend/). Docker users can now consume vSphere Storage (vSAN, VMFS, NFS) to stateful containers using Docker.
vSphere Storage for Docker enables customers to address persistent storage requirements for Docker containers in vSphere environments. This service is integrated with [Docker Volume Plugin framework](https://docs.docker.com/engine/extend/). Docker users can now consume vSphere Storage (vSAN, VMFS, NFS, VVoL) to stateful containers using Docker.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VVoL => VVOL or VVol

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

README.md Outdated
@@ -24,10 +24,10 @@ Detailed documentation can be found on our [GitHub Documentation Page](http://vm

The download consists of 2 parts:

1. VIB (vDVS driver): The ESX code is packaged as [a vib or an offline depot](http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vsphere.install.doc/GUID-29491174-238E-4708-A78F-8FE95156D6A3.html#GUID-29491174-238E-4708-A78F-8FE95156D6A3)
2. Managed plugin (vDVS plugin): Plugin is available on [Docker store](https://store.docker.com/plugins/e15dc9d5-e20e-4fb8-8876-9615e6e6e852?tab=description).
1. VIB (vSphere Storage driver for Docker): The ESX code is packaged as [a vib or an offline depot](http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vsphere.install.doc/GUID-29491174-238E-4708-A78F-8FE95156D6A3.html#GUID-29491174-238E-4708-A78F-8FE95156D6A3)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are still using the abbr "VDVS" in other places, here we should also keep it consistent, i.e. "VDVS driver".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure!

README.md Outdated
1. VIB (vDVS driver): The ESX code is packaged as [a vib or an offline depot](http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vsphere.install.doc/GUID-29491174-238E-4708-A78F-8FE95156D6A3.html#GUID-29491174-238E-4708-A78F-8FE95156D6A3)
2. Managed plugin (vDVS plugin): Plugin is available on [Docker store](https://store.docker.com/plugins/e15dc9d5-e20e-4fb8-8876-9615e6e6e852?tab=description).
1. VIB (vSphere Storage driver for Docker): The ESX code is packaged as [a vib or an offline depot](http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vsphere.install.doc/GUID-29491174-238E-4708-A78F-8FE95156D6A3.html#GUID-29491174-238E-4708-A78F-8FE95156D6A3)
2. Managed plugin (vSphere Storage plugin for Docker): Plugin is available on [Docker store](https://store.docker.com/plugins/e15dc9d5-e20e-4fb8-8876-9615e6e6e852?tab=description).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly - "VDVS plugin".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@shuklanirdesh82
Copy link
Contributor Author

@shaominchen Thanks for the comment! I have addressed all your comments.

shaominchen
shaominchen approved these changes Dec 15, 2017
View reviewed changes
Copy link
Contributor

@shaominchen shaominchen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

govint
govint approved these changes Dec 15, 2017
View reviewed changes
Copy link
Contributor

@govint govint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@shuklanirdesh82
Repo rename (Part#4) [SKIP CI]
56e5a01 
1. Update for README.md, CONTRIBUTING.md etc
2. Update in customer facing document
3. vDVS ===> VDVS (as we can't use small v)
@shuklanirdesh82 shuklanirdesh82 merged commit 10cd894 into vmware-archive:master Dec 15, 2017
@shuklanirdesh82 shuklanirdesh82 deleted the readMeUpdate.shuklanirdesh82 branch December 15, 2017 19:10
shuklanirdesh82 added a commit that referenced this pull request Dec 15, 2017
@shuklanirdesh82
Test Repo rename: markdown files update - part#4 (#2040)
4c606e8 
* Repo rename (Part#4) [SKIP CI]

1. Update for README.md, CONTRIBUTING.md etc
2. Update in customer facing document
3. vDVS ===> VDVS (as we can't use small v)

* Resign the secrete
shuklanirdesh82 added a commit that referenced this pull request Dec 15, 2017
@shuklanirdesh82
Test Repo rename: markdown files update - part#4 (#2040)
f13b5b5 
* Repo rename (Part#4)

1. Update for README.md, CONTRIBUTING.md etc
2. Update in customer facing document
3. vDVS ===> VDVS (as we can't use small v)

* Resign the secrete
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shaominchen shaominchen shaominchen approved these changes

@govint govint govint approved these changes

@tusharnt tusharnt Awaiting requested review from tusharnt

Assignees

@shuklanirdesh82 shuklanirdesh82

Labels
cla-not-required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@shuklanirdesh82 @govint @shaominchen @vmwclabot