Formatting standard and conventions

Documenting Knative API Objects

Use upper camel case for Knative API objects.

Correct	Incorrect
Channels	channels
Broker	broker
ContainerSource	Container Source

Using parentheses

Don’t use parentheses, unless it’s the first instance in a page to explain an acronym that isn’t immediately obvious.

Parenthetical statements especially should be avoided because if something is important enough to be in the sentence, it should be fully part of that sentence.

Correct	Incorrect
Install the Custom Resource Definition (CRD)	Check your CLI (you should see it there)
Knative Serving will create a Revision	Knative will create a Revision (a stateless, snapshot in time of your code and configuration)

Use sentence case for titles and headings

Use sentence case for all titles and headings. Only capitalize the first word of the heading, except for proper nouns or acronyms.

Correct	Incorrect
Configuring feature	Configuring Feature
Using feature	Using Feature
Using HTTPS	Using https

Create descriptive links

Correct	Incorrect
Check out this excellent article explaining what makes a good hyperlink	Check out the article here

Use spaces in units of measurement

For most units of measurement, when you specify a number with the unit, use a nonbreaking space between the number and the unit.

Don't use spacing when the unit of measurement is percent.

Correct	Incorrect
3&nbspGB	3 GB
4&nbspCPUs	4 CPUs
14%	14&nbsp%