Skip to content
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

Merged
merged 2 commits into from
Jul 22, 2017
Merged

#1545: Fix release instructions for documentation [SKIP CI] #1610

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
839ace5
#1545: Fix release instructions for documentation
girishshilamkar Jul 19, 2017
07b55ca
Update CONTRIBUTING.md as per review comments
girishshilamkar Jul 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

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
Copy link
Contributor

Choose a reason for hiding this comment

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

need to add # 5.

#Bug in jekyll template does not render the name "index"
vi ../documentation/index.html
Copy link
Contributor

@shuklanirdesh82 shuklanirdesh82 Jul 20, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

can we supply a command to update this field automatically? .. like sed/awk command to update the line

BTW, manual addition works fine :-)


# 6. Push to GitHub
git add documentation
git commit
Expand Down