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

Update telemetry.md #19469

Closed
wants to merge 1 commit into from
Closed

Update telemetry.md #19469

wants to merge 1 commit into from

Conversation

dmaklygin
Copy link

There is an inconsistency between code and docs.

Issue:

What I did

Renamed env variable in docs

How to test

  • Is this testable with Jest or Chromatic screenshots?
  • Does this need a new example in the kitchen sink apps?
  • Does this need an update to the documentation?

If your answer is yes to any of these, please make sure to include it in your PR.

There is an inconsistency between code and docs.
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@dmaklygin one small item to address on this that I would like to hear from you.

Hope you have a great weekend.

Stay safe

@@ -44,7 +44,7 @@ Access to the raw data is highly controlled, limited to select members of Storyb

## What about sensitive information?

We take your privacy and our security very seriously. We perform additional steps to ensure that secure data (e.g., environment variables or other forms of sensitive data) **do not** make their way into our analytics. You can view all the information we collect by setting the `STORYBOOK_TELEMETRY_DEBUG` to `1` to print out the information gathered. For example:
We take your privacy and our security very seriously. We perform additional steps to ensure that secure data (e.g., environment variables or other forms of sensitive data) **do not** make their way into our analytics. You can view all the information we collect by setting the `STORYBOOK_DEBUG_TELEMETRY` to `1` to print out the information gathered. For example:
Copy link
Contributor

Choose a reason for hiding this comment

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

@dmaklygin, can you elaborate on this? Upon checking the documentation (code and snippets) this is actually correct. Unless I'm missing something the change you're introducing is actually a misconception.

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch labels Oct 16, 2022
@jonniebigodes jonniebigodes self-assigned this Oct 16, 2022
shilman added a commit that referenced this pull request Oct 17, 2022
@shilman
Copy link
Member

shilman commented Oct 17, 2022

Thanks @dmaklygin -- this is actually a bug in the telemetry implementation & I've added a fix in #19509 that will get patched back to 6.5. Closing this PR!

@shilman shilman closed this Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants