isabella232 / docs-pcf-bosh Goto Github PK

Overview

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.

Locate the Topics and Subnav

Edit the individual topics in the docs-content folder.

Edit the subnav at docs-book/master_middleman/source/subnavs/pcfbosh_subnav.erb

Use Bookbinder To View and Publish Docs

Bookbinder is a command-line utility for stitching Markdown docs into a hostable web app.

You can use Bookbinder to

• View a live version of these docs on your local machine while editing.
• Publish your documentation changes from your local machine to the live docs site.

When you follow the instructions below, you will run bundle install locally which will install the bookbinder command line utility for you.

View Docs

To use Bookbinder to view your documentation, perform the following steps:

1. Clone this repo to your local machine.
2. On your local machine, cd into docs-book in the cloned repo.
3. Run bundle install to make sure you have all the necessary gems installed.
4. Run 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.

Publish Docs

1. Clone this repo to your local machine.
2. On your local machine, cd into docs-book in the cloned repo.
3. Run bundle install to make sure you have all the necessary gems installed.
4. Run bookbinder bind local to build a Rack web-app of the book.
5. cd into the final_app directory.
6. Log into PEZ HeritageCF and target the appropriate org and space: 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.
7. Run 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/