/docs-ops-manager

Primary LanguageHTML

Ops Manager Documentation

This repository contains content for the Ops Manager documentation. We publish the Ops Manager documentation at https://docs.pivotal.io/platform/ops-manager/index.html.

How To Contribute

Please help us improve the accuracy and completeness of the Ops Manager documentation by contributing content, editing, or expertise.

A common way to contribute is to file a pull request through GitHub.

Every topic in the Ops Manager documentation has a corresponding file in the https://github.com/pivotal-cf/docs-ops-manager content repository in GitHub. To locate the source file for a topic, navigate to the topic on the Ops Manager 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 Ops Manager v2.11 pre-release https://docs-pcf-staging.cfapps.io/ops-manager/2-11/
2.10 Ops Manager v2.10 https://docs.pivotal.io/platform/ops-manager/2-10/index.html
2.9 Ops Manager v2.9 https://docs.pivotal.io/platform/ops-manager/2-9/index.html
2.8 Ops Manager v2.8 https://docs.pivotal.io/platform/ops-manager/2-8/index.html
2.7 Ops Manager v2.7 https://docs.pivotal.io/platform/ops-manager/2-7/index.html
2.6 Ops Manager v2.6 https://docs.pivotal.io/platform/ops-manager/2-6/index.html
2.5 Ops Manager v2.5 https://docs.pivotal.io/platform/ops-manager/2-5/index.html
2.4 Ops Manager v2.4 https://docs.pivotal.io/platform/ops-manager/2-4/index.html
2.3 Ops Manager v2.3 https://docs.pivotal.io/platform/ops-manager/2-3/index.html
2.2 Ops Manager v2.2 https://docs.pivotal.io/platform/ops-manager/2-2/index.html
2.1 Ops Manager v2.1 https://docs.pivotal.io/platform/ops-manager/2-1/index.html
2.0 Ops Manager v2.0 https://docs.pivotal.io/platform/ops-manager/2-0/index.html

master: The master branch is used to publish the pre-release v2.11 site. Create pull requests on master to contribute or correct technical inaccuracies in the Ops Manager v2.11 documentation.

2.10: The 2.10 branch is used to publish the v2.10 site. Create pull requests on 2.10 to contribute or correct technical inaccuracies in the Ops Manager v2.10 documentation.

2.9: The 2.9 branch is used to publish the v2.9 site. Create pull requests on 2.9 to contribute or correct technical inaccuracies in the Ops Manager v2.9 documentation.

2.8: The 2.8 branch is used to publish the v2.8 site. Create pull requests on 2.8 to contribute or correct technical inaccuracies in the Ops Manager v2.8 documentation.

2.7: The 2.7 branch is used to publish the v2.7 site. Create pull requests on 2.7 to contribute or correct technical inaccuracies in the Ops Manager v2.7 documentation.

2.6: The 2.6 branch is used to publish the v2.6 site. Create pull requests on 2.6 to contribute or correct technical inaccuracies in the Ops Manager v2.6 documentation.

2.5: The 2.5 branch is used to publish the v2.5 site. The 2.5 branch has reached End of General Support and is no longer being updated.

2.4: The 2.4 branch is used to publish the v2.4 site. The 2.4 branch has reached End of General Support and is no longer being updated.

2.3: The 2.3 branch is used to publish the v2.3 site. The 2.3 branch has reached End of General Support and is no longer being updated.

2.2: The 2.2 branch is used to publish the v2.2 site. The 2.2 branch has reached End of General Support and is no longer being updated.

2.1: The 2.1 branch is used to publish the v2.1 site. The 2.1 branch has reached End of General Support and is no longer being updated.

2.0: The 2.0 branch is used to publish the v2.0 site. The 2.0 branch has reached End of General Support and is no longer being updated.

How To Use Bookbinder To View Your Documentation

Bookbinder is a command-line utility for stitching Markdown documents into a hostable web app. The 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-om, 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 the docs-book-om and docs-layout-repo repositories to the ~/workspace directory on your local machine.
  3. Navigate into the docs-book-om directory.
  4. Run bundle install to install all of the necessary gems, including Bookbinder.
  5. Run bundle exec bookbinder bind local to build a Rack web-app of the book. After the bind has completed, navigate into the final_app directory and run rackup. Then navigate to localhost:9292/platform/ops-manager/index.html in a browser.

Continuous Integration and Continuous Delivery

We use Concourse pipelines to provide continuous integration and continuous delivery. Any change made to this repository or the https://github.com/pivotal-cf/docs-book-om Book repository trigger a "bind" where the disparate parts of the Ops Manager documentation are assembled into a single web app. A successful bind triggers pushing the app to the staging site, https://docs-pcf-staging.cfapps.io/platform/ops-manager. After review, the staging site is manually pushed to the production site, https://docs.pivotal.io/platform/ops-manager/.

Concourse Pipelines: