/docs-ops-manager

Apache License 2.0Apache-2.0

Ops Manager Documentation

This repository contains content for the Ops Manager documentation. We publish the Ops Manager documentation at https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/index.html.

In this README:

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 this repository. 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 Branches

Content Branch Published URL
3.0 https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/index.html
2.10 https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/2.10/vmware-tanzu-ops-manager/index.html
2.9 Not supported. https://docs.pivotal.io/ops-manager/2-9/index.html (archived and publiched as a PDF)
2.8 Not supported. https://docs.pivotal.io/ops-manager/2-8/index.html (archived and publiched as a PDF)
2.7 Not supported. https://docs.pivotal.io/ops-manager/2-7/index.html (archived and publiched as a PDF)
master not used
master not used
2.6 https://docs.pivotal.io/ops-manager/2-6/index.html
2.5 https://docs.pivotal.io/ops-manager/2-5/index.html
2.4 https://docs.pivotal.io/ops-manager/2-4/index.html
2.3 https://docs.pivotal.io/ops-manager/2-3/index.html
2.2 https://docs.pivotal.io/ops-manager/2-2/index.html
2.1 https://docs.pivotal.io/ops-manager/2-1/index.html
2.0 https://docs.pivotal.io/ops-manager/2-0/index.html

3.0: The 3.0 branch is used to publish the v3.0 site. Create pull requests on 3.0 to contribute or correct technical inaccuracies in the Ops Manager v3.0 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.

Publishing Docs (2.10 and later)

The 2.10 and later docs have been migrated to docs.vmware.com and are now published using the following tools:

  • docworks is the main tool for managing docs used by writers.
  • docsdash is a deployment UI which manages the promotion from staging to pre-prod to production. The process below describes how to upload our docs to staging, replacing the publication with the same version.

Prepare Markdown Files

This repo contains the following files:

  • Markdown files live in this repo.
  • The table of contents is now in this repo in the toc.md file. Each page requires an entry in the TOC.
  • Variables also live in this repo in the template_variables.yml.

In DocWorks

  1. Run a build of the "VMware Tanzu Ops Manager" project to upload the docs to Docs Dash.
  2. Review your changes on the staging site https://docs-staging.vmware.com/...

In Docsdash

  1. Wait about 1 minute for processing to complete after uploading.
  2. Go to https://docsdash.vmware.com/deployment-stage.

Promoting to Pre-Prod and Prod

Prerequisite Needs additional privileges - reach out to a manager on the docs team #tanzu-docs or ask a writer to do this step for you.

  1. Go to Staging publications in docsdash
    https://docsdash.vmware.com/deployment-stage

  2. Select a publication (make sure it's the latest version)

  3. Click "Deploy selected to Pre-Prod" and wait for the pop to turn green (refresh if necessary after about 10s)

  4. Go to Pre-Prod list
    https://docsdash.vmware.com/deployment-pre-prod

  5. Select a publication

  6. Click "Sign off for Release"

  7. Wait for your username to show up in the "Signed off by" column

  8. Select the publication again

  9. Click "Deploy selected to Prod"

Publishing Docs (2.9 and earlier)

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 following repositories to the ~/workspace directory on your local machine:
  3. Use the Versions and Branching table above to determine which branch of docs-ops-manager that you need to git checkout to build the version of the documentation that you want. If necessary, navigate to the docs-ops-manager directory and git checkout BRANCH-NAME.
  4. Navigate in the docs-book-om directory.
  5. Run bundle install to install all of the necessary gems, including Bookbinder.
  6. 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: