Content style
ClickHouse uses US English in official communications however when a blog post is attributed to an individual, they can use the English that best represents them.
Titles
At ClickHouse we use sentence case rather than one of the competiting title cases. This means that the first word of a sentence, and any names values afterwards should be captialised, while any other word should be lowercased.
Dos: A brand new release from ClickHouse
Don’ts: A Brand New Release from ClickHouse
Ampersands
While ampersands can make titles shorter and more readable, they don’t make sense to use in many situations. For consistency reasons we recommend not using them for official ClickHouse communications.
Dos Logs, events, and traces
Don’ts Logs, events, & traces
Commas
ClickHouse uses the Oxford comma when listing items.
Dos Logs, events, and traces
Don’ts Logs, events and traces
Date and time formats
When using local dates we use a three-letter abbreviation for the month (“Apr”), followed by the day (“20”) and the year (“2024”).
If required for additional context, we add the day of the week (“Sat” for Saturday) before the abbreviated month, day, and year.
When using the 12 hour clock, we use the lowercase a.m. and p.m. with a space before it and punctuation.
Dos
Apr 20, 2024
Sat, Apr 20, 2024
2:00 p.m.
Don’ts
April 20th 2024
20th April, 2024
Saturday, April 20th, 2024
2:00PM
2:00 PM
2:00pm
Abbreviations
Countries
ClickHouse adheres to AP style for country names, which means we generally avoid abbreviations and prefer using full country names. However, there are a few exceptions:
- Instead of “United States of America,” we use “United States.”
- Instead of “United Kingdom of Great Britain and Northern Ireland,” we use “United Kingdom.”
Dos
United States
Netherlands
United Arab Emirates
Don’ts
US / U.S.A
UAE
JP