This style guide will help you understand the Glossary audience, definition structure, required level of detail, and how to keep a consistent style.
The Cloud Native Glossary follows the default style guide of the CNCF repository. Additionally, it follows the following rules:
- Use simple, accessible language, avoiding technical jargon and buzzwords
- Avoid colloquial language
- Use literal and concrete language
- Omit contractions
- Use passive voice sparingly
- Aim to phrase statements in a positive form
- No exclamation marks outside of quotations
- Do not exaggerate
- Avoid repetition
- Be concise
The Glossary is written for technical and non-technical audiences. Please explain definitions in simple terms, and don’t assume technical knowledge. More about this is below in Definition.
Minimum viable definition
We aim to make it easy for anyone to understand cloud native terms. As such, we focus on simplicity. Use clear, simple language with examples anyone who uses technology can relate to while also providing a minimum viable definition, at least from a technical point of view. We don’t want to save on context and examples—after all, those things help the reader understand the concept—but if a technical detail is not needed to understand it, we’ll skip it. The goal is not to overcomplicate things. Once the reader understands the basic idea, other resources will help them dig deeper. That part is out of the scope of this Glossary.
Each glossary term is stored in a markdown file and follows this template:
--- title: status: category: --- A quick summary of the technology or concept. ## Problem it addresses A few lines about the problem it's addressing. ## How it helps A few lines on how the thing solves the problem.
The title label will always be at the top of a definition layout, and its value should be in title case.
--- title: Definition Template
The status label will come after the title label. These labels indicate the amount of effort still required to complete the definition.
Valid values are:
- Feedback Appreciated
- Not Started
You can always open an issue against a completed definition. While a definition is in flux, its status will be changed to Feedback Appreciated. Note that we should not localize the valid status values.
--- title: Definition Template status: Feedback Appreciated
The tag label follows the status label.
For the tags to be meaningful and thus helpful to the user, we will use them in a strict sense.
Applying too many tags will only dilute its meaning.
An exception to this is the
fundamental tag, which indicates this term is needed to understand other cloud native concepts; most terms will likely only have one tag.
Note: Please only introduce new tags if approved by the maintainers. When you add tags to an entry, ensure they are spelled exactly as listed below (singular, no typos).
The current tags are:
--- title: Definition Template status: Feedback Appreciated tags: ["tag 1", "tag 2", ""] ---
The definitions for technology and concept categories contain a quick summary and two subheadings:
- (quick summary) provide a short and clear overview of what we are talking about.
- Problem it addresses: focus on the problem, not the solution (that comes in the next section). Avoid mentioning the term that is defined. The problem focuses on what led us to need that thing.
- How it helps: now, come back to the term. How does it address the problem described above?
Note that properties don’t require separate sections. A definition will suffice.
Please use semantic line breaks (one sentence per line) to ease review.
Quality is paramount
If merged, your submission will be the official CNCF definition for that term (until someone else improves it). Creating a term that meets the CNCF’s high standards can’t be rushed—quality takes time and effort.
Do your research: Even if you are confident you know the term, verify you got it right. We often use terms in organizations in a certain way that may not reflect the full picture. When researching, especially when you’re not 100% familiar with the term, use multiple resources. Many definitions are one-sided, especially if provided by a vendor. The Glossary must contain vendor-neutral, globally accepted definitions.
Don’t plagiarize. The same rules apply to Glossary as to any other serious publication. Don’t copy and paste other people’s work unless you are quoting and contributing it to them. If you like a particular section of a definition, paraphrase it in your own words.
Reference authoritative resources. When possible, link to authoritative resources such as project docs. Note that we cannot link to content developed by vendors.
Keeping it simple
The Glossary aims to explain complex concepts in simple words—a surprisingly difficult task that will likely take multiple revisions. Always keep the audience in mind when drafting your definition. Avoid using industry terms and buzzwords—you might catch yourself returning to them and may need to train yourself to look for different terms.
When appropriate, use real-world examples that help readers (especially non-technical ones) better understand when and why the idea you’re explaining is relevant.
When used in your definition, always link to existing glossary terms (only the first mention should be hyperlinked).
Example: look at the summary section of the service mesh definition. It links back to the definitions of microservices, service, reliability, and observability. Additionally, it uses a real-world example comparing network challenges in a microservices environment (something non-technical people can’t relate to) to wifi problems (something anyone using a laptop can understand). Where possible, try to make that connection.
Start with a Google or Word doc
We recommend starting with a Google or Word doc, letting it sit for a few days, and revisiting it. This will allow you to catch phrases or expressions that could be worded in a more straightforward and accessible way. Also, make sure to run a spellcheck before submitting a PR.
To ensure no one else submits a PR while working on a term, claim an issue (or create one) and request it be assigned to you. More about that in the How To Contribute doc.
Before getting started, please read some published Glossary terms to get a feeling for the level of detail and difficulty and when examples are appropriate.
The review process: What to expect
Please note that we are currently only three maintainers doing this in their spare time. Occasionally, we’ll be able to review terms quickly; on other occasions, it may take some time—we appreciate your patience. If you have any questions, please contact us in the #glossary Slack channel (for where and how to find it, please refer to our How To Contribute doc).
Our goal is for the Glossary to be the best possible resource. Once you submit a PR, we may ask for one or more revisions. Don’t get frustrated—that is the case for many PRs. These back and forths and our collaboration will ensure that your contribution becomes a helpful definition read and referred to by readers all around the globe.