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

docs: add warning notice to internal storybook #7338

Merged
merged 2 commits into from
Jul 19, 2023

Conversation

jcfranco
Copy link
Member

Related Issue: N/A

Summary

This displays a notice for anyone that might still be looking at the storybook link, which has now been deprecated (as component doc) in favor of the official documentation site.

Screenshot 2023-07-18 at 5 09 20 PM

Note: this won't be displayed for Chromatic Storybook builds

@jcfranco jcfranco requested a review from macandcheese July 19, 2023 00:14
@github-actions github-actions bot added the docs Issues relating to documentation updates only. label Jul 19, 2023
@jcfranco jcfranco added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label Jul 19, 2023
Copy link
Member

@benelan benelan left a comment

Choose a reason for hiding this comment

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

👍


<template id="internalStorybookNotice">
<calcite-notice open icon="exclamation-mark-triangle" closable kind="warning" scale="l" style="font-family: var(--calcite-sans-family)">
<div slot="title">This storybook is meant for internal, testing purposes only (using @next)</div>
Copy link
Member

Choose a reason for hiding this comment

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

Nitpick:

Maybe something like this would be more clear that it is using next itself and not just a tool for testing next in some way.

This storybook is on the current @next version and is meant for internal, testing purposes only.

Copy link
Member

@geospatialem geospatialem left a comment

Choose a reason for hiding this comment

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

Great addition, thanks for putting together! 🙌🏻

Concur with Ben's comment for clarity, otherwise LGTM! 🚀

Copy link
Member

@driskull driskull left a comment

Choose a reason for hiding this comment

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

💯

@jcfranco jcfranco added skip visual snapshots Pull requests that do not need visual regression testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jul 19, 2023
@jcfranco jcfranco merged commit 1b6b605 into main Jul 19, 2023
@jcfranco jcfranco deleted the jcfranco/add-warning-notice-to-internal-storybook branch July 19, 2023 17:59
@github-actions github-actions bot added this to the 2023 July Priorities milestone Jul 19, 2023
benelan added a commit that referenced this pull request Jul 20, 2023
…shot-doc

* origin/main:
  chore: release next
  fix(tooltip): ensure --calcite-app-z-index-tooltip is applied (#7345)
  docs: add warning notice to internal storybook (#7338)
  chore: remove references to removed cleanup script (#7339)
  chore: drop Airtable syncing action (#7340)
  chore: release next
  fix(color-picker): maintains correct numbering system when entering invalid RGB value (#7327)
  ci: notify teams about calcite-components releases only (#7317)
  build(deps): Bump rollup from 2.77.1 to 3.26.0 (#7264)
  build(deps): Bump eslint-plugin-jsdoc from 46.4.3 to 46.4.4 (#7329)
  build(deps): Bump semver and @types/semver (#7309)
benelan added a commit that referenced this pull request Aug 3, 2023
…lds (#7424)

**Related Issue:** #7338

## Summary

Creates a `STORYBOOK_SNAPSHOT_LOCAL_BUILD` environment variable and
automatically sets it in the `docs:preview` npm script. When the
environment variable is truthy, the storybook build:

- Hides the warning banner
- Displays both TestOnly and NoTest stories
benelan added a commit that referenced this pull request Aug 3, 2023
…lds (#7424)

**Related Issue:** #7338

## Summary

Creates a `STORYBOOK_SNAPSHOT_LOCAL_BUILD` environment variable and
automatically sets it in the `docs:preview` npm script. When the
environment variable is truthy, the storybook build:

- Hides the warning banner
- Displays both TestOnly and NoTest stories
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues relating to documentation updates only. skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants