Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

BeforeAfter
“the account that owns this network”"The Account that owns this Network."
"Deploys a new virtual machine.""Deploys a new Instance."

3.

...

All references to CloudStack-managed objects in user-facing content; including CWIKI documentation, Admin UI strings, and API reference docs, should use the canonical Title Case name.

...

Code Comments

Use Title Case when describing Object relationships or model entities.

Code Block
languagejava
themeDJango
/**
 * Associates the Network with an Account and allocates IP addresses for Instances.
 */

4. Acronym Capitalization

Acronyms used in object names, UI labels, API field descriptions, and user-facing documentation must be written in UPPERCASE. This applies to commonly used technical acronyms such as:

  • ID
  • UUID
  • IP
  • VLAN
  • VPC
  • and other standardized acronyms

Examples:

  • Account ID (not Account Id)
  • Instance UUID (not Instance Uuid)
  • IP Address (not Ip Address)
  • VLAN Range (not Vlan Range)
  • VPC Offering (not Vpc Offering)

Note:
This rule applies to object naming, UI text, and documentation.
It does not override the CloudStack coding-style guideline that discourages uppercase acronyms in Java variable and method names.

5. Documentation and UI

All references to CloudStack-managed objects in user-facing content; including CWIKI documentation, Admin UI strings, and API reference docs, should use the canonical Title Case name.

Notes for Contributors

  • Always verify whether the term refers to a CloudStack Object Type before applying Title Case.

  • Do not change API names or parameters that are public-facing or backward-compatible (e.g., deployVirtualMachine); only update descriptions, logs, and documentation.

  • Use Instance instead of Virtual Machine or VM in all new code, messages, and documentation.

  • Community feedback is welcome via mailing list or JIRA.