Skip to content

Commit

Permalink
Merge pull request #18167 from storybookjs/docs-telemetry-disclosure
Browse files Browse the repository at this point in the history
add telemetry disclosure on the install, upgrade and CLI pages
  • Loading branch information
jonniebigodes authored May 6, 2022
2 parents 6c2a88c + fb3f18e commit 553f732
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/api/cli-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: 'CLI options'

Storybook comes with two CLI utilities: `start-storybook` and `build-storybook`.

<div class="aside">
Storybook collects completely anonymous data to help us improve user experience. Participation is optional, and you may [opt-out](../configure/telemetry.md#how-to-opt-out) if you'd not like to share any information.
</div>

Pass these commands the following options to alter Storybook's behavior.

## start-storybook
Expand Down
8 changes: 6 additions & 2 deletions docs/configure/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This upgrades all of the Storybook packages in your project to the latest stable

<div class="aside">

In addition to running the command, we also recommend checking the [MIGRATION.md file](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md), for the detailed log of relevant changes and deprecations that might affect your upgrade.
In addition to running the command, we also recommend checking the [MIGRATION.md file](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md), for the detailed log of relevant changes and deprecations that might affect your upgrade.

</div>

Expand All @@ -42,4 +42,8 @@ To upgrade to the latest pre-release:
npx sb@next upgrade --prerelease
```

If you'd like to downgrade to a stable version, manually edit the package version numbers in your `package.json` and re-install.
If you'd like to downgrade to a stable version, manually edit the package version numbers in your `package.json` and re-install.

<div class="aside">
Storybook collects completely anonymous data to help us improve user experience. Participation is optional, and you may [opt-out](../configure/telemetry.md#how-to-opt-out) if you'd not like to share any information.
</div>
6 changes: 5 additions & 1 deletion docs/get-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,12 @@ Below are some of the most common installation issues and instructions on how to

<!-- prettier-ignore-end -->

<div class="aside">
Storybook collects completely anonymous data to help us improve user experience. Participation is optional, and you may [opt-out](../configure/telemetry.md#how-to-opt-out) if you'd not like to share any information.
</div>

If all else fails, try asking for [help](https://storybook.js.org/support)

</details>

Now that you installed Storybook successfully, let’s take a look at a story that was written for us.
Now that you installed Storybook successfully, let’s take a look at a story that was written for us.

0 comments on commit 553f732

Please sign in to comment.