Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 6.1 KB

README.md

File metadata and controls

82 lines (52 loc) · 6.1 KB
Raw

Documentation Repository for Application Service Adapter

Branches

Branch Usage Sites
main Branch for the v1.4 release. Staging · Prod
1-3 Branch for the v1.3 release. Staging · Prod
1-2 Branch for the v1.2 release. Staging · Prod
1-1 Branch for the v1.1 release. Staging · Prod
1-0 Branch for the v1.0 release. Staging · Prod

Publishing Docs

Staging and Publishing:

  • DocWorks is the main tool for managing docs used by writers.
  • Docs Dashboard 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

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

Create the Zip File

Before you generate the zip file for upload, make sure that your repository is up to date with the latest changes. We recommend running git pull right beforehand to ensure that any remote changes are pulled to your local repository.

From the root directory of this repository, run the prepare-zip script. This script will delete any existing zip files and create a new zip file named tas-adapter.zip containing the documentation files.

Upload the Zip File to Docworks

  • Log into DocWorks and navigate to the Markdown HTML publishing page.
  • Fill in the fields exactly as in the VMwarePub.yaml file. Repeat this every time, and note that the browser can help to remember form fields.
  • Select the zip file to upload from your local system. This should be the tas-adapter.zip file generated above.
  • Click Upload, and when prompted, enter your VMware AD password.
  • If you see invalid path errors in the yellow box on the right, there are broken links but the site will still be published.
  • If the toc.md is invalid, then the site will not build but there is no indication that something is wrong.

In Docs Dashboard

  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.

Promoting to Pre-Prod and Prod

Prerequisite Needs additional privileges - reach out to the docs team in #tanzu-docs to 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"

Landing Page and Publications

General information about landing pages:

  • Every product has a landing page (Not exactly true: every umbrella product, such as Tanzu Application Platform should have a landing page.)
  • The landing page is a container for all the "publications" for a product. Our first publication will be our combined docs for our first Beta, including installation, and user docs.
  • Typically there will be a new docs publication for each minor release but not each point release. This version number become part of the URL e.g. Our first release was version 0.1 (see form section above for the current release).
  • Some products like Tanzu Kubernetes Grid publish separate release notes publications for each point release.
  • For comparison see https://docs.vmware.com/en/VMware-Tanzu-Application-Catalog/index.html