secure-infrastructure-vpc

Documentation repository for solution docs for "Secure infrastructure on VPC for regulated industries" (staging output)

Creating content

Drafting content

1. Fork this repo.

2. Create a working branch from the draft branch.

3. Make your changes to the Markdown content.

   We use Markdown with a few custom extensions to source the docs. For tips about how to structure and style your docs with IBM Cloud Markdown, see Quick tips for authoring in IBM Cloud Docs in "Creating solution, deployment, and migration guides".

4. Commit your updates.

5. Create a pull request from your branch to draft.

When changes are merged to the draft branch, they are built and published to staging at https://test.cloud.ibm.com/docs/secure-infrastructure-vpc.

Publishing to production

1. Work in draft branch until you're happy with the output on staging.

2. Merge or copy content from draft to publish. For more information about how to merge from draft to production, see https://test.cloud.ibm.com/docs/writing?topic=writing-doc-build-git#doc-build-prod-push.

   ❗ Important: Do not expose IBM Confidential information in your commits to publish. Commits made in the publish branch become public record. When you commit to the publish branch, the source is mirrored in a public GitHub repo at https://github.com/ibm-cloud-docs/secure-infrastructure-vpc so that customers can view and contribute to your source.

3. Create a pull request.

When changes are merged to the production branch, they are built and published to production at https://cloud.ibm.com/docs/secure-infrastructure-vpc. So, changes can’t go into the branch until they are reviewed, edited, and approved by a one of the doc maintainers.

Monitoring

Monitoring builds

The Slack channel #docs-secure-infrastructure-vpc displays information about builds.

Monitoring content quality

You can monitor your content quality on the Content Quality Dashboard (CQD): https://cops.console.test.cloud.ibm.com/docs-quality-dashboard. The CQD for docs content is updated daily For more information, see https://test.cloud.ibm.com/docs/writing?topic=writing-cqd.

More information

• Learn about the suggested content for each type of solution docs at https://test.cloud.ibm.com/docs/writing?topic=writing-writing-solution.