Change products.core to lowercase "self-hosted" #19083

rmloveland · 2024-10-31T20:29:05Z

Formerly, this variable was capitalized as "Self-Hosted" which could be confusing since it implied the term was a proper noun. However, it is not. There is no such Product Name (tm), it's just an adjective referring to the deployment model.

Related to DOC-10665

github-actions · 2024-10-31T20:29:28Z

Files changed:

src/current/_includes/v24.2/known-limitations/datadog-self-hosted-limitations.md:

src/current/_includes/v24.3/known-limitations/datadog-self-hosted-limitations.md:

netlify · 2024-10-31T20:29:37Z

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name	Link
🔨 Latest commit	`3361615`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/672bca56423b1b000869479d

netlify · 2024-10-31T20:29:37Z

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name	Link
🔨 Latest commit	`3361615`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-api-docs/deploys/672bca566c71ba00087304ba

rmloveland · 2024-10-31T20:31:52Z

@jaiayu tagging you FYI, no need to review this two character change :-)

@taroface thanks for the docs team discussion that prompted this - @jaiayu and I discussed with Product Marketing in DMs, and Ayushi decided let's just go with lowercase for now and reassess, and PMM was ok with that

netlify · 2024-10-31T20:35:39Z

✅ Netlify Preview

Name	Link
🔨 Latest commit	`3361615`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-docs/deploys/672bca560e56b70008100add
😎 Deploy Preview	https://deploy-preview-19083--cockroachdb-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

taroface · 2024-10-31T21:02:37Z

This is the change we discussed. Also as discussed, though, it may lead to some unintentional or awkward wordings, like here:

The CockroachDB self-hosted integration with Datadog enables data collection and alerting...

The way this is phrased, it reads more as though the integration (not CockroachDB) is self-hosted. I'm wondering if there is a way to mitigate some of these instances. It appears that there are just a handful of instances of The CockroachDB {{ site.data.products.core }} on each docs branch that could be misread this way. "The self-hosted integration", "The self-hosted Production Checklist".

Another thing is that we still have some occurrences of Self-Hosted because people (like me) forgot to use the product variable. We should find-replace those occurrences.

Formerly, this variable was capitalized as "Self-Hosted" which could be confusing since it implied the term was a proper noun. However, it is not. There is no such Product Name (tm), it's just an adjective referring to the deployment model. Related to DOC-10665

rmloveland · 2024-11-05T19:28:43Z

This is the change we discussed. Also as discussed, though, it may lead to some unintentional or awkward wordings, like here:
The CockroachDB self-hosted integration with Datadog enables data collection and alerting...
The way this is phrased, it reads more as though the integration (not CockroachDB) is self-hosted. I'm wondering if there is a way to mitigate some of these instances. It appears that there are just a handful of instances of The CockroachDB {{ site.data.products.core }} on each docs branch that could be misread this way. "The self-hosted integration", "The self-hosted Production Checklist".

Good point, I have gone through and tried to edit all of these instances so they read a bit more naturally as "The integration of your CRDB self-hosted cluster with Datadog"

Another thing is that we still have some occurrences of Self-Hosted because people (like me) forgot to use the product variable. We should find-replace those occurrences.

I have find-replaced them in all cases except where they occur in the YAML front matter of the page (where variable substitution does not work), in which case I have edited them to say "self-hosted" (lowercase) so they do not appear to be Product Names (tm)

NB. i have applied all of these changes across v23.1, v23.2, v24.1, v24.2, v24.3. All changes are on the commit with the message Update with taroface feedback (1)

PTAL!

taroface

Clarifications are great -- only thing is that the page titles still need to be in title case, meaning Self-Hosted is still uppercase. I edited these as suggestions that you should be able to batch-apply from the reviewer pane. Let me know if it doesn't make sense.

src/current/v24.1/encryption.md

src/current/v23.1/datadog.md

src/current/v23.2/datadog.md

src/current/v24.1/authentication.md

src/current/v24.1/datadog.md

src/current/v24.3/datadog.md

src/current/v24.3/encryption.md

src/current/v24.3/essential-alerts-self-hosted.md

src/current/v24.3/essential-metrics-self-hosted.md

src/current/v24.3/sso-sql.md

Co-authored-by: Ryan Kuo <[email protected]>

rmloveland · 2024-11-06T19:06:58Z

@taroface applied all suggested changes, PTAL!

taroface

LGTM!!

"Self-Hosted" came back even though it was killed in #19083

rmloveland requested review from taroface and jaiayu October 31, 2024 20:29

rmloveland added 2 commits November 5, 2024 13:46

Update with taroface feedback (1)

f412df0

rmloveland force-pushed the 20241031-DOC-10665-make-it-lowercase branch from 4b1c68c to f412df0 Compare November 5, 2024 19:26

taroface requested changes Nov 5, 2024

View reviewed changes

rmloveland and others added 17 commits November 6, 2024 13:59

Update src/current/v24.1/encryption.md

7ff3539

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v23.1/datadog.md

3d92562

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v23.2/datadog.md

4c6eb16

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.1/authentication.md

e15893d

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.1/datadog.md

7333be7

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.1/essential-alerts-self-hosted.md

7af3c8e

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.3/datadog.md

5ffe76b

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.3/encryption.md

69df566

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.3/essential-alerts-self-hosted.md

0fcef80

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.3/essential-metrics-self-hosted.md

78449ab

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.1/essential-metrics-self-hosted.md

cb9f661

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.2/authentication.md

d8d8d0d

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.2/datadog.md

c36639f

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.2/encryption.md

207672d

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.2/essential-alerts-self-hosted.md

9aaba88

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.2/essential-metrics-self-hosted.md

ede782f

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.3/authentication.md

8718f44

Co-authored-by: Ryan Kuo <[email protected]>

rmloveland and others added 4 commits November 6, 2024 14:04

Update with taroface feedback (2)

2849dcf

Update src/current/v24.1/sso-sql.md

2a963de

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.3/sso-sql.md

2bf2444

Co-authored-by: Ryan Kuo <[email protected]>

Update src/current/v24.2/sso-sql.md

187ece5

Co-authored-by: Ryan Kuo <[email protected]>

taroface approved these changes Nov 6, 2024

View reviewed changes

Merge branch 'main' into 20241031-DOC-10665-make-it-lowercase

3361615

rmloveland enabled auto-merge (squash) November 6, 2024 19:58

rmloveland merged commit 951ae17 into main Nov 6, 2024
7 checks passed

rmloveland deleted the 20241031-DOC-10665-make-it-lowercase branch November 6, 2024 20:05

rmloveland mentioned this pull request Nov 15, 2024

Backport changes from #19002 #19138

Merged

rmloveland added a commit that referenced this pull request Nov 15, 2024

Fix another merge skew thing

313d450

"Self-Hosted" came back even though it was killed in #19083

rmloveland mentioned this pull request Nov 18, 2024

V24.3 ga docs #19107

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change products.core to lowercase "self-hosted" #19083

Change products.core to lowercase "self-hosted" #19083

rmloveland commented Oct 31, 2024

github-actions bot commented Oct 31, 2024 •

edited

Loading

netlify bot commented Oct 31, 2024 •

edited

Loading

netlify bot commented Oct 31, 2024 •

edited

Loading

rmloveland commented Oct 31, 2024

netlify bot commented Oct 31, 2024 •

edited

Loading

taroface commented Oct 31, 2024

rmloveland commented Nov 5, 2024 •

edited

Loading

taroface left a comment

rmloveland commented Nov 6, 2024

taroface left a comment

Change products.core to lowercase "self-hosted" #19083

Change products.core to lowercase "self-hosted" #19083

Conversation

rmloveland commented Oct 31, 2024

github-actions bot commented Oct 31, 2024 • edited Loading

Files changed:

netlify bot commented Oct 31, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

netlify bot commented Oct 31, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

rmloveland commented Oct 31, 2024

netlify bot commented Oct 31, 2024 • edited Loading

✅ Netlify Preview

taroface commented Oct 31, 2024

rmloveland commented Nov 5, 2024 • edited Loading

taroface left a comment

Choose a reason for hiding this comment

rmloveland commented Nov 6, 2024

taroface left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 31, 2024 •

edited

Loading

netlify bot commented Oct 31, 2024 •

edited

Loading

netlify bot commented Oct 31, 2024 •

edited

Loading

netlify bot commented Oct 31, 2024 •

edited

Loading

rmloveland commented Nov 5, 2024 •

edited

Loading