Giter Club home page Giter Club logo

docs-pks's Introduction

Enterprise Pivotal Container Service (Enterprise PKS) Documentation

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

The content in this repository publishes to the Enterprise 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 Enterprise PKS documentation by contributing.

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

Every topic in the Enterprise PKS documentation site has a corresponding file in this repository. Locate the correct file and make a pull request against it. You can also navigate to the topic in the Enterprise 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
master Enterprise PKS 1.5 pre-release content N/A
1.4 Enterprise PKS 1.4.x released content https://docs.pivotal.io/runtimes/pks/1-4/index.html
1.4.x-patch-releases Enterprise PKS 1.4.x pre-release content N/A
1.3 Enterprise PKS 1.3.x released content https://docs.pivotal.io/runtimes/pks/1-3/index.html
1.3.x-patch-releases Enterprise PKS 1.3.x pre-release content N/A
1.2 Enterprise PKS 1.2.x released content https://docs.pivotal.io/runtimes/pks/1-2/index.html
1.2.x-patch-releases Enterprise PKS 1.2.x pre-release content N/A
1.1 Not in use N/A (PDF available)
1.0-publish Not in use N/A (PDF available)
0.8 Not in use N/A

master: The master branch is used to publish the pre-release v1.5 version of the site. Create pull requests on master to contribute bug fixes or correct technical inaccuracies in the v1.5 documentation. This documentation requires validation. Contact #pcf-docs on Pivotal Slack for access.

1.4: The 1.4 branch is used to publish the live v1.4 version of the site. Create pull requests on 1.4 to contribute bug fixes or correct technical inaccuracies in the v1.4 documentation.

1.4.x-patch-releases: The 1.4.x-patch-releases branch is used to work on documentation for the pre-release v1.4.x version of Enterprise PKS. This branch publishes to an internal staging site only. Create pull requests on 1.4.x-patch-releases to contribute content or correct technical inaccuracies in the v1.4.x pre-release documentation. This documentation requires validation. Contact #pcf-docs on Pivotal Slack for access.

1.3: The 1.3 branch is used to publish the live v1.3 version of the site. Create pull requests on 1.3 to contribute bug fixes or correct technical inaccuracies in the v1.3 documentation.

1.3.x-patch-releases TThe 1.3.x-patch-releases branch is used to work on documentation for the pre-release v1.3.x version of Enterprise PKS. This branch publishes to an internal staging site only. Create pull requests on 1.3.x-patch-releases to contribute content or correct technical inaccuracies in the v1.3.x pre-release documentation. This documentation requires validation. Contact #pcf-docs on Pivotal Slack for access.

1.2: The 1.2 branch is used to publish the live v1.2 version of the site. Create pull requests on 1.2 to contribute bug fixes or correct technical inaccuracies in the v1.2 documentation.

1.2.x-patch-releases TThe 1.2.x-patch-releases branch is used to work on documentation for the pre-release v1.2.x version of Enterprise PKS. This branch publishes to an internal staging site only. Create pull requests on 1.2.x-patch-releases to contribute content or correct technical inaccuracies in the v1.2.x pre-release documentation. This documentation requires validation. Contact #pcf-docs on Pivotal Slack for access.

The 1.1 branch is no longer maintained. A PDF of the Enterprise PKS v1.0 documentation is available at https://docs.pivotal.io/archives/pks-docs-1.1.pdf.

The 1.0-publish and 0.8 branches are no longer maintained. A PDF of the Enterprise PKS v1.0 documentation is available at https://docs.pivotal.io/archives/pks-docs-1.0.pdf.

How To Use Bookbinder To View Your Documentation

Bookbinder is a command-line utility for stitching Markdown documents into a hostable web app. The PCF Documentation 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 repository, 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 repository 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 documentation and navigate to localhost:4567/runtimes/pks/1-5/index.html in a browser. (It may take a moment for the site to load at first.) This builds a site from your content repository at docs-content, and then watches that repository to update the site if you make any changes to the repository.
  • 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/runtime/pks/1-4/index.html in a browser.

docs-pks's People

Contributors

alamages avatar alex-slynko avatar altonf4 avatar angelachin avatar animatedmax avatar apeek4 avatar astrieanna avatar bentarnoff avatar carlo-colombo avatar cshollingsworth avatar ctaymor avatar ericivorychambers avatar frodenas avatar gmrodgers avatar kdolor-pivotal avatar lfengpivotal avatar ljarzynski avatar lparis avatar mjgutermuth avatar mlimonczenko avatar neil-hickey avatar nikitarathi23 avatar pspinrad avatar radaeze avatar ryanjjones10 avatar seviet avatar skelly-pivotal avatar terminatingcode avatar vikafed avatar virtmerlin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.