Change products.core to lowercase "self-hosted"

rmloveland commented 3 weeks ago

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[bot] commented 3 weeks ago

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[bot] commented 3 weeks ago

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

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

netlify[bot] commented 3 weeks ago

Deploy Preview for cockroachdb-api-docs canceled.

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

rmloveland commented 3 weeks ago

@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[bot] commented 3 weeks ago

Netlify Preview

Name	Link
Latest commit	3361615e6f9fbfcfddd52b46a11e143a09d44507
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 commented 3 weeks ago

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.

rmloveland commented 2 weeks ago

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!

rmloveland commented 2 weeks ago

@taroface applied all suggested changes, PTAL!

cockroachdb / docs