Text conventions
As you noticed there are a lot of different kinds of text messages in each view:
- Titles.
- Headers.
- Labels.
- Values.
- Action button.
- Menu and navigation entries.
- All kinds of messages including warnings, errors and help information.
- Grammar - Using a verb in infinitive or gerund form?
- Punctuation - Using a period or not?
- Capitalization - Using capitalized words? Capitalize Kubernetes specific names?
In addition, with few exceptions, all text messages within the Dashboard should be localized. For more details check our internationalization guidelines).
The gerund form should be used everywhere. Exceptions are all kinds of messages including warnings, errors and help information.
- All kinds of messages including warnings, errors and help information.
Periods should be avoided for:
- Headers.
- Labels.
- Values.
- Tooltips.
- Menu and navigation entries.
In general, all kinds of messages should have their first word capitalized. Exceptions are:
- Names which appear in the middle of a message.
- Values and table contents.
- Application names - Kubernetes, Kubernetes Dashboard etc.
- Resource names - Pod, Service, Endpoint, Node etc.
Copyright 2019