This repository has been archived by the owner on Nov 9, 2020. It is now read-only.
[SKIP CI] Updating the script that copies changes to gh-pages from vmware/master #1863
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
How about renaming to publish_document.sh/update_gh_pages.sh? |
misc/scripts/updateGHpages.sh
Outdated
| Following script copies the markdown files from vmware:master to gh-pages | ||
| Local copy of vDVS project is needed before running this script (git clone https://github.com/vmware/docker-volume-vsphere.git) | ||
| Script has to be run from the docker-volume-vsphere/ | ||
| e.g. ./misc/scripts/updateGHpages.sh |
There was a problem hiding this comment.
minor: ./misc/scripts/updateGHpages.sh => ./misc/scripts/<script_name> .. it will be outdated soon when script name got rename.
misc/scripts/updateGHpages.sh
Outdated
| # e.g. ./misc/scripts/updateGHpages.sh | ||
|
|
||
| set -e | ||
| : ' |
misc/scripts/updateGHpages.sh
Outdated
| Script has to be run from the docker-volume-vsphere/ | ||
| e.g. ./misc/scripts/updateGHpages.sh | ||
|
|
||
| Before executing this script, its important to have two git remotes : origin and vmware |
There was a problem hiding this comment.
would suggest to move this pre-requisite before line#6
misc/scripts/updateGHpages.sh
Outdated
| @@ -1,10 +1,21 @@ | |||
| #!/bin/bash | |||
There was a problem hiding this comment.
Renamed the script to updateGHpages.sh
How about renaming to publish_document.sh/update_gh_pages.sh?
shuklanirdesh82
approved these changes
Sep 5, 2017
misc/scripts/update_gh_pages.sh
Outdated
| @@ -50,18 +73,22 @@ rm -rf $BACKUP_DIR | |||
|
|
|||
| echo "Performing steps to generate customer facing document" | |||
| cd jekyll-docs/ | |||
|
|
|||
| # generating the html pages | |||
There was a problem hiding this comment.
nit: generating => Generating .. the same as line#61
misc/scripts/update_gh_pages.sh
Outdated
| docker run --rm --volume=$(pwd):/srv/jekyll -it jekyll/jekyll:stable jekyll build | ||
| rm -rvf ../documentation | ||
| mv _site ../documentation | ||
|
|
||
| #updating documentation/index.html | ||
| # updating documentation/index.html |
|
Addressed all the review comments. Merging the changes. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Following changes have been made to the script: