Name: docs-pcf-bosh
Owner: Pivotal Cloud Foundry
Description: null
Created: 2016-12-01 02:32:57.0
Updated: 2017-05-01 20:08:30.0
Pushed: 2017-08-01 00:27:26.0
Homepage: null
Size: 2344
Language: HTML
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This repo contains the documentation for PCF BOSH. The repo contains the following folders:
docs-book
: The configuration and subnav for the book.docs-content
: The content for the book, in Markdown files.docs-layout
: The layout for the book, including stylesheets, fonts, and images.Edit the individual topics in the docs-content
folder.
Edit the subnav at docs-book/master_middleman/source/subnavs/pcfbosh_subnav.erb
Bookbinder is a command-line utility for stitching Markdown docs into a hostable web app.
You can use Bookbinder to
When you follow the instructions below, you will run bundle install
locally which will install the bookbinder
command line utility for you.
To use Bookbinder to view your documentation, perform the following steps:
cd
into docs-book
in the cloned repo.bundle install
to make sure you have all the necessary gems installed.bookbinder watch
to build an interactive version of the docs and navigate to localhost:4567/pcfbosh/
in a browser. (It may take a moment for the site to load at first.) This builds a site from your content repo at docs-content
, and then watches that repo to update the site if you make any changes to the repo.cd
into docs-book
in the cloned repo.bundle install
to make sure you have all the necessary gems installed.bookbinder bind local
to build a Rack web-app of the book.cd
into the final_app
directory.cf login -a api.run.pez.pivotal.io -o pcf-bosh -s pcf-bosh --sso
. You'll need to follow the link provided by the cf
CLI, and then make sure to choose the option to log in with Okta.cf push bosh-native-pcf-docs -b ruby_buildpack -d pezapp.io
.After the push command has completed, view the docs at https://bosh-native-pcf-docs.pezapp.io/