Pivotal Container Service (PKS) Documentation

This repo contains the content for the documentation for Pivotal Container Service (PKS).

The content in this repo publishes to the PKS documentation site at https://docs.pivotal.io/runtimes/pks/index.html.

How To Contribute

Please help us improve the accuracy and completeness of the PKS documentation by contributing.

The easiest way to contribute is to file a pull request through GitHub.

Every topic in the PKS documentation site has a corresponding file in this repo. Locate the correct file and make a pull request against it. You can also navigate to the topic in the PKS documentation site and click "View the source for this page in GitHub" at the bottom of the topic.

Versions and Branching

Branch Name	Content	Location
1.0-publish	PKS 1.0 released content	https://docs.pivotal.io/runtimes/pks/1-0/index.html
1.0-dev	PKS 1.0.x content in development	internal staging site
master	PKS 1.1.x content in development	internal staging site

The 1.0-publish branch is used to publish the live version of the site. Create pull requests on 1.0-publish to contribute bug fixes or correct technical inaccuracies.

The 1.0-dev branch contains content for the next PKS 1.0 patch release. Create pull requests on 1.0-dev when documenting features for an upcoming patch release. When the next PKS patch releases, the docs team merges 1.0-dev into 1.0-publish and cuts a new 1.0-dev branch.

The master branch contains content for the next major PKS release. Create pull requests on master when documenting features for the next major release. When the next major version of PKS releases, the docs team cuts new publish and dev branches.

How To Use Bookbinder To View Your Docs

Bookbinder is a command-line utility for stitching Markdown docs into a hostable web app. The PCF Docs Team uses Bookbinder to publish our documentation sites, but you can also use Bookbinder to view a live version of your documentation on your local machine.

Bookbinder draws the content for the site from this repo, the left navigation menu ("subnav") from docs-book-pks, and various layout configuration and assets from docs-layout-repo.

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

1. Clone this repo to the ~/workspace directory on your local machine.
2. Clone docs-book-pks and docs-layout-repo to the ~/workspace directory on your local machine.
3. Change into the docs-book-pks directory.
4. Run bundle install to install all of the necessary gems, including Bookbinder.
5. Build your documentation site with bookbinder in one of the two following ways:

• Run bundle exec bookbinder watch to build an interactive version of the docs and navigate to localhost:4567/myservice/ 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.
• Run bundle exec bookbinder bind local to build a Rack web-app of the book. After the bind has completed, cd into the final_app directory and run rackup. Then navigate to localhost:9292/myservice/ in a browser.