Skip to content

Commit

Permalink
Added quality section (#542)
Browse files Browse the repository at this point in the history
* Added quality section

* Update content/en/style-guide/_index.md

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* Update _index.md

* Update content/en/style-guide/_index.md

change request from seokho

Co-authored-by: Seokho Son <shsongist@gmail.com>

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Co-authored-by: Seokho Son <shsongist@gmail.com>
  • Loading branch information
3 people authored Mar 7, 2022
1 parent 8a87f5a commit b52feba
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions content/en/style-guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ The definitions for **technology** and **concept** categories contain three subh

Note that **properties** don't require separate sections. A definition will suffice.

#### 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 a certain way that may not reflect the full picture. When you do your research, 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.

#### Keeping it simple

The Glossary aims at **explaining complex concepts in simple words** — that is 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'll probably catch yourself going back to them and may need to autocorrect.
Expand Down

0 comments on commit b52feba

Please sign in to comment.