This repo contains the VMware Tanzu Service Broker for AWS documentation.

In this README:

• VMware Tanzu Service Broker for AWS
  • Branches
  • Partials
  • Contributing to documentation
  • Publishing docs
    • Prepare Markdown files
    • In Docsdash
    • Promoting to pre-prod and prod
  • Troubleshooting Markdown
  • Style guide

Cross-product partials (if any) are single sourced from the Docs Partials repository.

If there is some documentation to add for an unreleased patch version of these docs, then create a branch off of the live branch you intend to modify and create a pull request against that branch. After the version that change is targeting is released, the pull request can be merged and will be live the next time a documentation deployment occurs.

If the documentation is meant to be target several released versions, then you will need to:

• create a pull request for each individual minor version
• or ask the technical writer to cherry-pick to particular branches/versions.

For instructions on how to create a pull request on a branch and instructions on how to create a pull request using a fork, see Creating a PR in the documentation team wiki.

• 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.

• Markdown files live in this repo.
• Images should live in an images directory at the same level and linked with a relative link.
• Each page requires an entry in config/toc.md for the table of contents.
• Variables live in config/template_variables.yml.

1. Wait about 1 minute for processing to complete after uploading.

2. Go to https://docsdash.vmware.com/deployment-stage

   There should be an entry with a blue link which says Documentation and points to staging.

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"

This is a word list for terminology and word usage specific to the VMware Tanzu Service Broker for AWS for docs.