Metric Store Docs

These are the docs for the Metric Store tile. We maintain documentation for each minor version of the Metric Store via branches.

Got a question or want to make a correction, feel free to submit an issue or a pull request!

Branches

Branch Name	Use for…
main	staged here: https://docs-staging.vmware.com/en/draft/Metric-Store/1.7/metric-store/GUID-index.html
1.6	v1.6 staging here: https://docs-staging.vmware.com/en/Metric-Store/1.6/metric-store/GUID-release-notes.html and prod here: https://docs.vmware.com/en/Metric-Store/1.6/metric-store/GUID-index.html
1.5	v1.5 staging here: https://docs-staging.vmware.com/en/Metric-Store/1.5/metric-store/GUID-release-notes.html and prod here: https://docs.vmware.com/en/Metric-Store/1.5/metric-store/GUID-index.html
1.4	DO NOT USE. Archived here: https://docs.vmware.com/en/Metric-Store/1.4/metric-store-1-4.pdf
1.3	DO NOT USE. Archived here: https://docs.vmware.com/en/Metric-Store/1.3/metric-store-1-3.pdf
0.3	DO NOT USE. Archived here: https://docs.vmware.com/en/Metric-Store/0.3/metric-store-0-3.pdf
0.2	DO NOT USE. Archived here: https://docs.vmware.com/en/Metric-Store/0.2/metric-store-0-2.pdf

Releasing a new minor version

Because main is the latest and greatest documentation, the process would be to cut a x.x branch for the version that main was targeting during that time.

After this point, main will then be the target for the next version of this product.

Partials

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

Contributing to documentation

If there is some documentation to add for an unreleased patch version, 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.

Publishing Docs

• 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

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

In Docsdash

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 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"

Troubleshooting Markdown

Problem	List displays as a paragraph
Symptom:	Bulleted or numbered lists look fine on GitHub but display as a single paragraph in HTML.
Solution:	Add a blank line after the stem sentence and before the first item in the list.

Problem	List numbering is broken: every item is 1.
Symptom:	Each numbered item in a list is a 1. instead of 1., 2., 3., etc
Solution:	Try removing any blank newlines within each step.

Problem	Code boxes not showing
Symptom:	VMware publishing system doesn't accept code tags after the three back ticks.
Solution:	Make sure you're not using shell or bash or console or yaml after back ticks.