Add document about releases for GA and post GA [SKIP CI]. #1843

lipingxue · 2017-08-28T21:02:22Z

shaominchen

Looks good. A few nits/typos below.

shaominchen · 2017-08-28T21:05:16Z

CONTRIBUTING.md

+
+edge release: will be released every month for users who want a drop of latest.
+
+stable release: will be release every 3 month for users who want to a stable version.


want to => want

shaominchen · 2017-08-28T21:06:12Z

CONTRIBUTING.md

+
+### Nomenclature for release:
+
+The Nomenclature for release will follow the format ```major-version. minor-version.build-version.release-type```.


Remove the redundant space after "major-version."

shaominchen · 2017-08-28T21:07:27Z

CONTRIBUTING.md

+
+The Nomenclature for release will follow the format ```major-version. minor-version.build-version.release-type```.
+
+“Major-Version” will be the major version number, “minor-version” will be the minor version number which will be bumped on each monthly release. “build-version” by default is 0. If we decide to cut one more release on that month (maybe some patch releases), we can increase the “build-version” by 1 for that release. “release-type” has two possible values: “stable” to mark a stable release and “edge” to mark a edge release.


will be bumped on each monthly release => will be bumped up for each monthly release

on that month => in that month

a edge => an edge

shaominchen · 2017-08-28T21:15:04Z

CONTRIBUTING.md

+
+“Major-Version” will be the major version number, “minor-version” will be the minor version number which will be bumped on each monthly release. “build-version” by default is 0. If we decide to cut one more release on that month (maybe some patch releases), we can increase the “build-version” by 1 for that release. “release-type” has two possible values: “stable” to mark a stable release and “edge” to mark a edge release.
+
+For Example, assume we plan to cut the first release for GA on August , the release number will be “1.0.0.stable”. Then the monthly edge release on September will be “1.1.0.edge”, the monthly release on October will be “1.2.0.edge” and the stable release on November will be “1.3.0.stable”, etc.


on August/September/October/November => in August/...

Remove the redundant space after "August"

shaominchen · 2017-08-28T21:17:18Z

docs/user-guide/faq.md

+
+edge release: will be released every month for users who want a drop of latest.
+
+stable release: will be release every 3 month for users who want to a stable version.


want to => want

shuklanirdesh82 · 2017-08-28T21:37:37Z

CONTRIBUTING.md

@@ -277,6 +277,24 @@ COVERAGE_PROCESS_START DEFAULT=/coverage.rc

 The CI/CD system is based on [Drone platform](https://drone.io/) and the server is  https://ci.vmware.run/. More information is found at our [CI.md](https://github.com/vmware/docker-volume-vsphere/blob/master/CI.md)

+## Releases for GA and post GA


nit: "vDVS release naming convention" or "Release naming convention"

shuklanirdesh82 · 2017-08-28T21:39:38Z

CONTRIBUTING.md

@@ -277,6 +277,24 @@ COVERAGE_PROCESS_START DEFAULT=/coverage.rc

 The CI/CD system is based on [Drone platform](https://drone.io/) and the server is  https://ci.vmware.run/. More information is found at our [CI.md](https://github.com/vmware/docker-volume-vsphere/blob/master/CI.md)

+## Releases for GA and post GA
+The following is the plan for releases for GA and post GA. Before GA, the release name format remains the same.


Not sure we should call out GA/Post GA, there will be a question from customer side about GA date.

/CC @tusharnt

shuklanirdesh82 · 2017-08-28T21:40:52Z

CONTRIBUTING.md

+### Type of Release:
+We plan to have two types of releases: edge release and stable release.
+
+edge release: will be released every month for users who want a drop of latest.


edge => Edge

shuklanirdesh82 · 2017-08-28T21:41:03Z

CONTRIBUTING.md

+
+edge release: will be released every month for users who want a drop of latest.
+
+stable release: will be release every 3 month for users who want to a stable version.


stable => Stable

shuklanirdesh82 · 2017-08-28T21:43:07Z

CONTRIBUTING.md

+
+### Nomenclature for release:
+
+The Nomenclature for release will follow the format ```major-version. minor-version.build-version.release-type```.


The Nomenclature => The nomenclature

shuklanirdesh82 · 2017-08-28T21:43:21Z

docs/user-guide/faq.md

+### Which release I should use?
+You can choose release based on your needs. There will be two types of releases: edge release and stable release.
+
+edge release: will be released every month for users who want a drop of latest.


same as above

ashahi1 · 2017-08-28T21:46:29Z

CONTRIBUTING.md

+
+edge release: will be released every month for users who want a drop of latest.
+
+stable release: will be release every 3 month for users who want to a stable version.


will be release >> will be released ?

shuklanirdesh82 · 2017-08-28T21:49:04Z

docs/user-guide/faq.md

@@ -19,6 +19,15 @@ This can be achieved via [Tenancy](http://vmware.github.io/docker-volume-vsphere
 ### Can I migrate data between Linux and Windows containers?
 Volumes created via the Linux plugin are formatted with ext4 by default, and the ones created via the Windows plugin are formatted with NTFS. While it is possible to cross-mount such volumes, the vSphere Storage for Docker plugin doesn't support such cases, nor does it provide any explicit help.

+### Which release I should use?
+You can choose release based on your needs. There will be two types of releases: edge release and stable release.


how about this?

Edge release: A monthly release with new features and bug fixes
Stable release: A quarterly release with reliable/stable updates

shuklanirdesh82 · 2017-08-28T21:52:43Z

docs/user-guide/faq.md

+
+stable release: will be release every 3 month for users who want to a stable version.
+
+For details about the nomenclature for release, please refer [here](/CONTRIBUTING.md/#releases-for-ga-and-post-ga).


How about this?

Please refer release convention for more details.

need to supply fully qualified link, I don't think public facing document will resolve /CONTRIBUTING.md/#repath.

shuklanirdesh82 · 2017-08-28T21:57:35Z

CONTRIBUTING.md

+
+The Nomenclature for release will follow the format ```major-version. minor-version.build-version.release-type```.
+
+“Major-Version” will be the major version number, “minor-version” will be the minor version number which will be bumped on each monthly release. “build-version” by default is 0. If we decide to cut one more release on that month (maybe some patch releases), we can increase the “build-version” by 1 for that release. “release-type” has two possible values: “stable” to mark a stable release and “edge” to mark a edge release.


Major-Version” will be the major version number :)

can you please elaborate more about major version?

lipingxue · 2017-08-28T22:53:55Z

@shaominchen @shuklanirdesh82 @ashahi1 I have addressed your comments.

shuklanirdesh82 · 2017-08-28T23:04:49Z

CONTRIBUTING.md

@@ -277,6 +277,24 @@ COVERAGE_PROCESS_START DEFAULT=/coverage.rc

 The CI/CD system is based on [Drone platform](https://drone.io/) and the server is  https://ci.vmware.run/. More information is found at our [CI.md](https://github.com/vmware/docker-volume-vsphere/blob/master/CI.md)

+## Release naming convention
+The following is the plan for releases for GA and post GA. Before GA, the release name format remains the same.


Need to reword as below:

The following is the plan for GA and post GA releases. Before GA, the release name format remains the same e.g. 0.XX (existing release tag)

shuklanirdesh82 · 2017-08-28T23:05:14Z

CONTRIBUTING.md

+We plan to have two types of releases: edge release and stable release.
+
+Edge release: A monthly release with new features and bug fixes.
+


nit: no need for extra line

That line is needed, otherwise, the line "edge release" and "stable release" will be in the same line when browsing the md file.

got it. Thanks for checking!

shuklanirdesh82 · 2017-08-28T23:12:01Z

docs/user-guide/faq.md

+You can choose release based on your needs. There will be two types of releases: edge release and stable release.
+
+Edge release: A monthly release with new features and bug fixes.
+


nit: same as above

shuklanirdesh82 · 2017-08-28T23:13:39Z

docs/user-guide/faq.md

+
+Stable release: A quarterly release with reliable/stable updates.
+
+For details about the nomenclature for release, please refer [here](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#release-naming-convention).


Please reword this as shown below:

Please refer [release convention](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#release-naming-convention) for more details.

View: Please refer release convention for more details.

shaominchen

LGTM.

lipingxue · 2017-08-29T16:39:52Z

@shuklanirdesh82 Could you review it?

shuklanirdesh82 · 2017-08-29T18:45:31Z

@shuklanirdesh82 Could you review it?

@lipingxue I am waiting for the comments to be addressed.

shuklanirdesh82

Thanks for having patience and addressing comments.

Please resolve conflict before merging your change.

Add documment about releases for GA and post GA. Minor fix to fix the link. Minor fix.

vmwclabot added the cla-not-required label Aug 28, 2017

shaominchen reviewed Aug 28, 2017

View reviewed changes

shuklanirdesh82 reviewed Aug 28, 2017

View reviewed changes

shuklanirdesh82 suggested changes Aug 28, 2017

View reviewed changes

ashahi1 reviewed Aug 28, 2017

View reviewed changes

shuklanirdesh82 reviewed Aug 28, 2017

View reviewed changes

shaominchen approved these changes Aug 28, 2017

View reviewed changes

shuklanirdesh82 approved these changes Aug 30, 2017

View reviewed changes

lipingxue added 3 commits August 29, 2017 20:24

Add documment about releases for GA and post GA.

d75983f

Add documment about releases for GA and post GA. Minor fix to fix the link. Minor fix.

Address comments from Sam, Nirdesh and Anup.

6d21822

Address more comments from Nirdesh.

7dcdf87

lipingxue force-pushed the release_document.liping branch from bd8c861 to 7dcdf87 Compare August 30, 2017 03:30

lipingxue merged commit c08bd58 into vmware-archive:master Aug 30, 2017


		edge release: will be released every month for users who want a drop of latest.

		stable release: will be release every 3 month for users who want to a stable version.


		### Nomenclature for release:

		The Nomenclature for release will follow the format ```major-version. minor-version.build-version.release-type```.


		The Nomenclature for release will follow the format ```major-version. minor-version.build-version.release-type```.

		“Major-Version” will be the major version number, “minor-version” will be the minor version number which will be bumped on each monthly release. “build-version” by default is 0. If we decide to cut one more release on that month (maybe some patch releases), we can increase the “build-version” by 1 for that release. “release-type” has two possible values: “stable” to mark a stable release and “edge” to mark a edge release.


		“Major-Version” will be the major version number, “minor-version” will be the minor version number which will be bumped on each monthly release. “build-version” by default is 0. If we decide to cut one more release on that month (maybe some patch releases), we can increase the “build-version” by 1 for that release. “release-type” has two possible values: “stable” to mark a stable release and “edge” to mark a edge release.

		For Example, assume we plan to cut the first release for GA on August , the release number will be “1.0.0.stable”. Then the monthly edge release on September will be “1.1.0.edge”, the monthly release on October will be “1.2.0.edge” and the stable release on November will be “1.3.0.stable”, etc.

		@@ -277,6 +277,24 @@ COVERAGE_PROCESS_START DEFAULT=/coverage.rc

		The CI/CD system is based on [Drone platform](https://drone.io/) and the server is https://ci.vmware.run/. More information is found at our [CI.md](https://github.com/vmware/docker-volume-vsphere/blob/master/CI.md)

		## Releases for GA and post GA


		stable release: will be release every 3 month for users who want to a stable version.

		For details about the nomenclature for release, please refer [here](/CONTRIBUTING.md/#releases-for-ga-and-post-ga).

		We plan to have two types of releases: edge release and stable release.

		Edge release: A monthly release with new features and bug fixes.

		You can choose release based on your needs. There will be two types of releases: edge release and stable release.

		Edge release: A monthly release with new features and bug fixes.


		Stable release: A quarterly release with reliable/stable updates.

		For details about the nomenclature for release, please refer [here](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#release-naming-convention).

Add document about releases for GA and post GA [SKIP CI]. #1843

Add document about releases for GA and post GA [SKIP CI]. #1843

Conversation

lipingxue commented Aug 28, 2017

shaominchen 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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lipingxue commented Aug 28, 2017

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

shaominchen left a comment

Choose a reason for hiding this comment

lipingxue commented Aug 29, 2017

shuklanirdesh82 commented Aug 29, 2017

shuklanirdesh82 left a comment

Choose a reason for hiding this comment