Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on telemetry collection #19131

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

rmloveland
Copy link
Contributor

Fixes DOC-11051

Copy link

github-actions bot commented Nov 13, 2024

Files changed:

  • src/current/_includes/common/telemetry-table.html
  • src/current/_includes/common/telemetry.md
  • src/current/_includes/v24.3/sidebar-data/reference.json
  • src/current/v24.3/telemetry.md

Copy link

netlify bot commented Nov 13, 2024

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit f53318a
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/67365f1eeca45100085a61b8

Copy link

netlify bot commented Nov 13, 2024

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit f53318a
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/67365f1e57da5500084c99c0

Copy link

netlify bot commented Nov 13, 2024

Netlify Preview

Name Link
🔨 Latest commit f53318a
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/67365f1e72f95e0008848c93
😎 Deploy Preview https://deploy-preview-19131--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

@taroface taroface left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's some broken formatting here. TLDR is:

  • No <p> tags inside table cells
  • Replace all <pre> tags with <code> tags

(Unless I missed a good reason for using either tag)

src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry.md Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry.md Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
src/current/_includes/common/telemetry-table.html Outdated Show resolved Hide resolved
@rmloveland
Copy link
Contributor Author

thanks for the review @taroface !!!

there's no good reason why i used any of the specific tags in this PR so i've updated everything based on your comments!

I think this is RFAL

@rmloveland
Copy link
Contributor Author

ps Ryan idk if you write a lot of {H,X}ML but i have used xmlformat for a long time and love it: https://formulae.brew.sh/formula/xmlformat

Copy link
Contributor

@taroface taroface left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with 2 nits, I wish I understood why the code blocks have extra spaces above and sometimes below, but oh well!

<code>
"licenseType": "Enterprise"
</code>
See also: Locality, Hardware Info, OS Info, Build Info, and Topology Info
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a <br> as this is bleeding out of the code

"provider": "gcp",
"instanceClass": "n2-standard-16"
</code>
See also CPU Info and Memory Info
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as below on adding a <br>

Suggested change
See also CPU Info and Memory Info
See also: CPU Info and Memory Info

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants