This repo contains the VMware RabbitMQ for Tanzu Application Service documentation.
In this README:
The main branch is the tree-trunk, so ALWAYS make changes you want carried forward in this branch. This includes:
- Unreleased features
- Doc bug fixes
- Doc reorganization or enhancement
Then, if necessary, immediately cherry-pick/copy any changes that you want to push immediately to production into the appropriate branches listed below:
Branch Name | Staging | Prod |
---|---|---|
main | v2.5 | N/A |
2.4 | v2.4 | v2.4 |
2.3 | v2.3 | v2.3 |
2.2 | v2.2 | v2.2 |
2.1 | v2.1 | v2.1 |
2.0 | NOT IN USE | |
1.21 | NOT IN USE | |
1.20 | NOT IN USE | |
1.19 | NOT IN USE | |
1.18 | NOT IN USE | |
1.17 | NOT IN USE | |
1.16 | NOT IN USE | |
1.15 | NOT IN USE | |
1.14 | NOT IN USE | |
1.13 | NOT IN USE | |
1.12 | NOT IN USE | |
1.11 | NOT IN USE | |
1.10 | NOT IN USE | |
1.9 | NOT IN USE | |
1.8 | NOT IN USE | |
1.7 | NOT IN USE | |
1.6 | NOT IN USE | |
1.5 | NOT IN USE |
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.
Cross-product partials for these docs 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.
-
Wait about 1 minute for processing to complete after uploading.
-
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.
-
Go to Staging publications in docsdash https://docsdash.vmware.com/deployment-stage
-
Select a publication (make sure it's the latest version)
-
Click "Deploy selected to Pre-Prod" and wait for the pop to turn green (refresh if necessary after about 10s)
-
Go to Pre-Prod list https://docsdash.vmware.com/deployment-pre-prod
-
Select a publication
-
Click "Sign off for Release"
-
Wait for your username to show up in the "Signed off by" column
-
Select the publication again
-
Click "Deploy selected to Prod"
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. |
Use this section to specify spelling of special words for VMware RabbitMQ for Tanzu Application Service:
- on-demand plan
- shared-VM plan
- dedicated-VM plan
- RabbitMQ Management UI