This repository has been archived by the owner on Nov 9, 2020. It is now read-only.
#1545: Fix documentation issues #1609
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@girishshilamkar Please update the PR description about the fixes that PR is focusing on. |
jekyll-docs/index.md
Outdated
| @@ -36,5 +36,5 @@ vDVS abstracts underlying enterprise class storage and makes it available as doc | |||
|
|
|||
| ## Documentation Version | |||
|
|
|||
| The documentation here is for the latest release. The current master documentation can be found in markdown format in the [documentation folder](https://github.com/vmware/docker-volume-vsphere/tree/gh-pages). For older releases, browse to [releases](https://github.com/vmware/docker-volume-vsphere/releases) select the release, click on the tag for the release and browse the docs folder. | |||
| The documentation here is for the latest release. The current master documentation can be found in jekyll/markdown format in [jekyll-docs folder](https://github.com/vmware/docker-volume-vsphere/tree/gh-pages/jekyll-docs). The doc site is generated at the time of release cut and served from [documentation folder](https://github.com/vmware/docker-volume-vsphere/tree/gh-pages/documentation) | |||
There was a problem hiding this comment.
This paragraph seems confusing to me.
- what is the plan for referring older release documentation?
- "The doc site is generated at the time of release cut and served from documentation folder" ..why is it included in the customer facing document?
ashahi1
reviewed
Jul 19, 2017
jekyll-docs/index.md
Outdated
| @@ -36,5 +36,5 @@ vDVS abstracts underlying enterprise class storage and makes it available as doc | |||
|
|
|||
| ## Documentation Version | |||
|
|
|||
| The documentation here is for the latest release. The current master documentation can be found in markdown format in the [documentation folder](https://github.com/vmware/docker-volume-vsphere/tree/gh-pages). For older releases, browse to [releases](https://github.com/vmware/docker-volume-vsphere/releases) select the release, click on the tag for the release and browse the docs folder. | |||
| The documentation here is for the latest release. The current master documentation can be found in jekyll/markdown format in [jekyll-docs folder](https://github.com/vmware/docker-volume-vsphere/tree/gh-pages/jekyll-docs). The doc site is generated at the time of release cut and served from [documentation folder](https://github.com/vmware/docker-volume-vsphere/tree/gh-pages/documentation) | |||
There was a problem hiding this comment.
So are we saying that updating the documentation on vmware master on github will not automatically update the document at vmware.github.io? Can you please clarify?
/cc @tusharnt
shuklanirdesh82
approved these changes
Jul 20, 2017
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addressing following things for #1545