Skip to content

Instantly share code, notes, and snippets.

@craigshoemaker
Last active January 16, 2024 22:48
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save craigshoemaker/6abcc80dfd9aa675c14fbef6f0a236ca to your computer and use it in GitHub Desktop.
Save craigshoemaker/6abcc80dfd9aa675c14fbef6f0a236ca to your computer and use it in GitHub Desktop.
Azure Container Apps branding guidelines

Branding guidelines for Azure Container Apps

  • The service name is "Azure Container Apps", so that means there is no such thing as the following:

    • Azure Container App / Container App (title case, singular)
    • Container app (mixed case, singular)
  • A single instance is referenced as a "container app" (no caps), as that is not a branded term.

  • "ACA" is internal shorthand and must not appear in the docs.

  • Using "Container Apps" as the service name after declaring "Azure Container Apps" used once on the page is acceptable.

  • Unbranded key terms such as environment, container, revisions, and the like follow sentence case rules.

    • Sentence case rules dictate that you only capitalize the first letter when its a part of a title or at the beginning of a sentence, otherwise unbranded key terms remain in lowercase.

Language specific content

The docs detail product truth. Any features or functionality of Container Apps that is tailored specifically to a language or runtime should be documented and featured in all the appropriate spots (including the TOC).

Alternatively, language specific procedures that have little to do with product features, but just show you can “do something generic” with a language are to be avoided.

Examples

After you deploy your container app, you may want to update some of the configuration settings.

Azure Container Apps allows you to build containerized applications without having to worry about the details of Kubernetes.

Terminology

Container Apps scales in and out.

If your application stops receiving requets, then the app scales in to zero.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment