glossary shortcode on the first mention of a DigitalOcean-specific term in getting started, conceptual, and cross-product documentation. Do not use it in headings, on repeated mentions, or excessively within glossary entries. Use tooltips only when they improve clarity and reduce friction.
Glossary Articles
Validated on 26 Jan 2026 • Last edited on 23 Feb 2026
Glossary articles define DigitalOcean-specific and platform-wide terminology used across Product Docs.
Glossary entries provide concise, authoritative definitions for terms that appear repeatedly throughout Product Docs. Each entry serves as a single canonical source of truth and must remain clear, consistent, and technically accurate.
The glossary documents DigitalOcean terminology, including:
- Product names
- Platform features
- Infrastructure concepts
- Shared terminology used across multiple products
- DigitalOcean-specific meanings of otherwise generic computing terms
Entries may describe a product family, a feature, or a platform concept, provided the definition is stable and broadly applicable.
Update glossary entries whenever a product definition changes, a feature is deprecated, renamed, redesigned, or otherwise evolves.
Avoid duplicating or fragmenting definitions across multiple entries. Each concept should have one glossary entry.
When to Add an Entry to the Glossary
Before adding a new glossary entry, consider the following questions:
- Is this a DigitalOcean-specific term, or a general term with a DigitalOcean-specific meaning?
- Does this term have a clear, stable definition?
- Is this term likely to be confusing or unfamiliar without explanation?
If the answer to any of these questions is no, reconsider adding a glossary entry.
| Concept | DO-specific? | Clearly defined? | Confusing or unfamiliar? | Add to glossary? |
|---|---|---|---|---|
| SSH keys | No. Not specific to DigitalOcean. | Yes. | Yes. Common stumbling block for new users. | No. |
| App spec | Yes. Specific to App Platform. | Yes. Consistent meaning on the platform. | Yes. Unique App Platform concept. | Yes. |
| Function | Yes. Despite multiple uses in computing. | Yes. Refers to a specific DigitalOcean product. | No. Meaning is clear in context. | No. |
| 1-Click App | Yes. Specific to Marketplace. | Yes. Used across Droplets and DOKS. | Yes. Not self-evident to new users. | Yes. |
How to Write a Glossary Entry
Glossary entries must be clear, objective, and technically accurate. Avoid conversational, promotional, or marketing language.
The content should:
- Be concise, direct, and factual.
- Provide the necessary context for the product it relates to.
- Stay within two paragraphs.
- Align to standard product tone and voice.
- Link to more detailed product documentation where helpful.
Description Field
The description front matter is used as hover text by the glossary shortcode.
A glossary description must:
- Provide the most important, high-level definition of the term.
- Be a sentence fragment.
- Stay within 25 words.
A glossary description must not include multiple sentences or excessive detail.
Entry Content
The body of a glossary entry provides additional context to explain how the term relates to DigitalOcean products or systems.
Entry content must:
- Be concise, direct, and factual.
- Use clear, objective, technical language.
- Provide only the context necessary to understand the term.
- Stay within two short paragraphs.
- Align with the standard Product Docs voice and tone.
- Link to primary product documentation only when it adds meaningful context. Use a single inline link placed at the end of the entry. Do not use link cards in glossary entries.
Do not include procedural steps, pricing or limits, reference tables, marketing language, or calls to action.