docs: add warning notice to internal storybook#7338
Merged
Conversation
jcfranco
requested review from
benelan,
driskull and
geospatialem
as code owners
jcfranco
added
the
pr ready for visual snapshots
benelan
approved these changes
Jul 19, 2023
|
|
||
| <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> |
Contributor
There was a problem hiding this comment.
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
@nextversion and is meant for internal, testing purposes only.
geospatialem
approved these changes
Jul 19, 2023
Member
geospatialem
left a comment
geospatialem
left a comment
There was a problem hiding this comment.
Great addition, thanks for putting together! 🙌🏻
Concur with Ben's comment for clarity, otherwise LGTM! 🚀
jcfranco
added
skip visual snapshots
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
Note: this won't be displayed for Chromatic Storybook builds