Name: vaquero-docs
Owner: CiscoCloud
Description: Documentation for the Vaquero project
Created: 2016-08-16 19:28:29.0
Updated: 2018-03-06 21:20:25.0
Pushed: 2017-11-27 21:13:54.0
Homepage: https://ciscocloud.github.io/vaquero-docs
Size: 3338
Language: CSS
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Documentation for the Vaquero project: https://github.com/CiscoCloud/vaquero
Website: https://ciscocloud.github.io/vaquero-docs
Updates to this repo automatically generate new documentation which will be published as static assets to using the GitHub Pages functionality. The documentation will be published according to these rules:
Changes to the master
branch are published into the current
version of the documentation.
https://github.com/CiscoCloud/vaquero-docs/tree/master/docs/current
When the documentation is tagged, a new version of the documents will be published using the version indicated in the tag. Future Roadmap
See: https://github.com/CiscoCloud/vaquero-docs/tree/master/docs
Individual branches will be published, as well.
https://github.com/CiscoCloud/vaquero-docs/tree/master/docs/branches
Install Ruby
RVM is a great tool for this. Follow the install instructions and then install the version in the .ruby-version file.
rvm install 2.4.2
Setup a gemset so your gems are isolated
rvm create gemset vqdocs
Install bundler
gem install bundler
Install gems (from the Gemfile file)
bundle install
Start jekyll to see the site
jekyll serve
View in your browser
http://localhost:4000
Make changes and jekyll will rebuild the site automatically.