This repository has been archived by the owner on Nov 9, 2020. It is now read-only.
#1545: Fix release instructions for documentation [SKIP CI] #1610
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
shuklanirdesh82
changed the title
|
@girishshilamkar for the documentation changes .. it is better to add |
shuklanirdesh82
suggested changes
Jul 20, 2017
CONTRIBUTING.md
Outdated
| @@ -337,6 +337,10 @@ docker run --rm --volume=$(pwd):/srv/jekyll -it jekyll/jekyll:stable jekyll buil | |||
| # 4. Remove the old site and copy the new one. | |||
| rm -rvf ../documentation | |||
| mv _site ../documentation | |||
| #Search for "Edit me" and ensure href is https://github.com/vmware/docker-volume-vsphere/edit/gh-pages/jekyll-docs//index.md | |||
CONTRIBUTING.md
Outdated
| @@ -337,6 +337,10 @@ docker run --rm --volume=$(pwd):/srv/jekyll -it jekyll/jekyll:stable jekyll buil | |||
| # 4. Remove the old site and copy the new one. | |||
| rm -rvf ../documentation | |||
| mv _site ../documentation | |||
| #Search for "Edit me" and ensure href is https://github.com/vmware/docker-volume-vsphere/edit/gh-pages/jekyll-docs//index.md | |||
| #Bug in jekyll template does not render the name "index" | |||
| vi ../documentation/index.html | |||
There was a problem hiding this comment.
can we supply a command to update this field automatically? .. like sed/awk command to update the line
BTW, manual addition works fine :-)
| @@ -337,6 +337,10 @@ docker run --rm --volume=$(pwd):/srv/jekyll -it jekyll/jekyll:stable jekyll buil | |||
| # 4. Remove the old site and copy the new one. | |||
There was a problem hiding this comment.
Please improve the formatting .. It is easier to miss some step especially for index.md part .. may be newline after each step would be better or anything else if you think of.
shuklanirdesh82
approved these changes
Jul 22, 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.
The stable docker image is updated and verified that images path is correct with this docker image.
Bug in jekyll template caused broken "edit me" link problem, added the step in release process to ensure it is correct.