docs icon indicating copy to clipboard operation
docs copied to clipboard

[STANDING ISSUE] Style and Word Usage updates

Open Loquacity opened this issue 3 years ago • 22 comments

Add comments to this issue as you come across things that should be noted in the style guide, WUG, or in our linter. This issue will be groomed regularly and the updates made in bulk.

Loquacity avatar Jul 29 '22 07:07 Loquacity

Add above and below to next and previous directional entries.

Loquacity avatar Jul 31 '22 23:07 Loquacity

Declare if procedure titles go inside or outside procedure tags.

Loquacity avatar Aug 01 '22 00:08 Loquacity

Add tobs (all lower case)

Loquacity avatar Aug 01 '22 00:08 Loquacity

Add once ("Once you have ..." etc). Recommend when.

Loquacity avatar Aug 03 '22 02:08 Loquacity

superuser or super user ?

  • Not listed here: https://developers.google.com/style/word-list#letter-s
  • Also not listed in IBM or Microsoft print guides
  • Ngram implies superuser is by far more popular:

image

Loquacity avatar Aug 03 '22 04:08 Loquacity

Bare metal (noun) bare-metal (adjective)

Loquacity avatar Aug 08 '22 02:08 Loquacity

Cybersecurity. One word.

Loquacity avatar Aug 11 '22 07:08 Loquacity

Appears

Loquacity avatar Aug 15 '22 05:08 Loquacity

Add DNS and REST to the list of accepted acronyms

charislam avatar Aug 18 '22 20:08 charislam

Log in: Verb Login: Adjective

Loquacity avatar Aug 24 '22 05:08 Loquacity

Fix the bare-metal/baremetal entry

image

Loquacity avatar Aug 24 '22 05:08 Loquacity

Log in: Verb Login: Adjective

Also noun? (for login)

charislam avatar Aug 24 '22 13:08 charislam

We don't use $, #, or sudo in command blocks.

Loquacity avatar Sep 19 '22 05:09 Loquacity

When referring to plain-old boring PostgreSQL, in order to differentiate it from Timescale, don't use vanilla. Instead, use standard PostgreSQL.

Additionally, if we don't already have it: PostgreSQL, never Postgres.

Loquacity avatar Sep 26 '22 06:09 Loquacity

Use: Primary and not Master Use: Secondary and not Slave

We need to decide on read-only replica or read-replica too.

Rajakavitha1 avatar Oct 18 '22 08:10 Rajakavitha1

fail over (verb), failover (noun, adjective)

Loquacity avatar Oct 20 '22 23:10 Loquacity

Frontend/Backend, per https://iobeam.slack.com/archives/C0J94TE4F/p1669229105071679

Loquacity avatar Nov 25 '22 04:11 Loquacity

Determine which of AWS and GCP need to be expanded: https://github.com/timescale/docs/pull/1816#discussion_r1035763064

Loquacity avatar Dec 02 '22 01:12 Loquacity

Add linting for "via" (I thought we already did this?)

Loquacity avatar Dec 05 '22 22:12 Loquacity

~Data set, or dataset? https://www.zumolabs.ai/post/2020/11/09/is-it-data-set-or-dataset~

Dataset, according to Google.

Loquacity avatar Jan 24 '23 23:01 Loquacity

Add hypershift to the accepted words list, and add capitalisation guidance to the WUG

Loquacity avatar Feb 08 '23 01:02 Loquacity

Add guidance about using bullets vs numbered lists ("is order important")

Loquacity avatar Mar 05 '23 23:03 Loquacity