Cloud directives (:::aws, etc.)
Cloud directives conditionally render a block of content only on one or more clouds, so a single source page can serve cloud-specific variations.
When to use
Use a cloud directive when a passage applies to some clouds but not others — a feature available only on AWS and Azure, a networking step that differs by cloud, or a note that is relevant to a single cloud. Prefer keeping shared content outside the directive and wrapping only the parts that differ.
Technical details
The following directives conditionally render content in one or more clouds:
:::aws:::azure:::gcp:::sap:::aws-azure:::aws-gcp:::aws-sap:::azure-gcp:::azure-sap:::gcp-sap:::aws-azure-gcp:::aws-azure-sap:::aws-gcp-sap:::azure-gcp-sap
Cloud directives can be nested. When nesting, the outer directive must use more colons than the directives nested inside it (for example, ::::aws-azure wrapping a :::aws block).
Rules
- Close each directive with a fence that matches its opening colon count.
- Nested directives require the outer wrapper to use more colons than any directive inside it.
Style
- Wrap only the content that actually differs by cloud; keep shared prose outside the directive to reduce duplication.
Template
:::aws
AWS-only content.
:::
Examples
Example:
::::aws-azure
> This only shows up in AWS and Azure.
> The directives can be nested but you need to use more colons.
:::aws
> AWS only.
:::
:::azure
> Azure only.
:::
::::
:::azure
> This only shows up in Azure.
:::
:::gcp
> This only shows up in GCP.
:::
Output:
This only shows up in AWS and Azure. The directives can be nested but you need to use more colons.
AWS only.
Used in
Content atoms appear in any page section. Cloud directives are common wherever a section's content diverges by cloud, such as Requirements and Procedure.