Skip to content

fix(Storybook): update documentation links #6989

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.

Sign up for GitHub

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

Merged
paul-balchin-ibm merged 10 commits into from
Mar 12, 2025
Merged

fix(Storybook): update documentation links #6989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
142994d
fix: storybook documentation links
paul-balchin-ibm Feb 26, 2025
63aa5ba
Merge branch 'main' into 6659_fix-storybook-docs-links
paul-balchin-ibm Feb 26, 2025
2282f63
Merge remote-tracking branch 'upstream/main' into 6659_fix-storybook-…
paul-balchin-ibm Mar 3, 2025
a2cbca5
fix: update as per comments
paul-balchin-ibm Mar 3, 2025
ee8f773
fix: updates as per comments
paul-balchin-ibm Mar 3, 2025
6f0656c
fix: update broken stories
paul-balchin-ibm Mar 3, 2025
0d38082
Update packages/ibm-products/src/components/TagSet/TagSet.stories.jsx
paul-balchin-ibm Mar 6, 2025
db37c27
fix: import and TagSet guidelines URL
elycheea Mar 6, 2025
ecd3714
Merge remote-tracking branch 'upstream/main' into 6659_fix-storybook-…
paul-balchin-ibm Mar 11, 2025
f732f30
fix: requested update
paul-balchin-ibm Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/ibm-products/src/components/APIKeyModal/APIKeyModal.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@

import React from 'react';
import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
import { useOf } from '@storybook/blocks';
import { storyDocsGuidelines } from '../../global/js/utils/story-helper';

import * as stories from './APIKeyModal.stories';

const DocsPage = () => {
const { csfFile } = useOf('meta', ['meta']);

return (
<StoryDocsPage
altGuidelinesHref={[
storyDocsGuidelines(csfFile),
{
href: 'https://pages.github.ibm.com/carbon/ibm-products/components/api-key-modal/usage/',
label: 'APIKeyModal usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/components/modal/usage',
label: 'Carbon Modal usage guidelines',
},
{
href: 'https://react.carbondesignsystem.com/?path=/docs/modal--default',
href: 'https://react.carbondesignsystem.com/?path=/docs/components-modal',
label: 'Carbon Modal documentation',
},
]}
Expand Down
15 changes: 14 additions & 1 deletion packages/ibm-products/src/components/AboutModal/AboutModal.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,20 @@ import * as stories from './AboutModal.stories';

const DocsPage = () => (
<StoryDocsPage
guidelinesHref="https://pages.github.ibm.com/carbon/ibm-products/components/about-modal/usage/"
altGuidelinesHref={[
{
href: 'https://pages.github.ibm.com/carbon/ibm-products/components/about-modal/usage/',
label: 'AboutModal usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/components/modal/usage',
label: 'Carbon Modal usage guidelines',
},
{
href: 'https://react.carbondesignsystem.com/?path=/docs/components-modal',
label: 'Carbon Modal documentation',
},
]}
blocks={[
{
story: stories.aboutModal,
Expand Down
4 changes: 4 additions & 0 deletions packages/ibm-products/src/components/ActionBar/ActionBar.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import React from 'react';
import { action } from '@storybook/addon-actions';
import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';

import { Bee, Lightning } from '@carbon/react/icons';

Expand Down Expand Up @@ -47,6 +48,9 @@ export default {
},
parameters: {
styles,
docs: {
page: () => <StoryDocsPage altGuidelinesHref="" />,
},
},
decorators: [(story) => <DisplayBox>{story()}</DisplayBox>],
};
Expand Down
13 changes: 6 additions & 7 deletions packages/ibm-products/src/components/Cascade/Cascade.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,18 @@
import React from 'react';
import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
import * as stories from './Cascade.stories';
import { useOf } from '@storybook/blocks';
import { storyDocsGuidelines } from '../../global/js/utils/story-helper';

const DocsPage = () => {
const { csfFile } = useOf('meta', ['meta']);

return (
<StoryDocsPage
altGuidelinesHref={[
storyDocsGuidelines(csfFile),
{
href: 'https://www.carbondesignsystem.com/guidelines/motion/overview/',
label: 'Carbon motion guidelines',
href: 'https://pages.github.ibm.com/carbon/ibm-products/patterns/cascade/',
label: 'Cascade usage guidelines',
},
{
href: 'https://carbondesignsystem.com/elements/motion/overview/',
label: 'Carbon Motion overview',
},
]}
blocks={[
Expand Down
6 changes: 6 additions & 0 deletions packages/ibm-products/src/components/Checklist/Checklist.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ import * as stories from './Checklist.stories';

const DocsPage = () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://pages.github.ibm.com/carbon/ibm-products/components/onboarding/checklist/usage/',
label: 'Checklist usage guidelines',
},
]}
blocks={[
{
story: stories.checklist,
Expand Down
2 changes: 2 additions & 0 deletions packages/ibm-products/src/components/Coachmark/Coachmark.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import * as CoachmarkStories from './Coachmark.stories';

# Coachmark

[Coachmark usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/components/onboarding/coachmark/usage/)

## Table of Contents

- [Overview](#overview)
Expand Down
2 changes: 2 additions & 0 deletions packages/ibm-products/src/components/ConditionBuilder/ConditionBuilder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import * as stories from './ConditionBuilder.stories';

# ConditionBuilder

[ConditionBuilder usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/components/condition-builder/usage/)

## Table of Contents

- [Overview](#overview)
Expand Down
2 changes: 1 addition & 1 deletion packages/ibm-products/src/components/CreateSidePanel/CreateSidePanel.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const DocsPage = () => {
altGuidelinesHref={[
{
href: 'https://pages.github.ibm.com/carbon/ibm-products/patterns/create-flows/usage/#side-panel',
label: 'Carbon create flows side panel usage guidelines',
label: 'CreateSidePanel usage guidelines',
},
]}
blocks={[
Expand Down
2 changes: 2 additions & 0 deletions packages/ibm-products/src/components/DataSpreadsheet/DataSpreadsheet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import * as stories from './DataSpreadsheet.stories';

# DataSpreadsheet

[DataSpreadsheet usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/components/data-spreadsheet/usage/)

## Table of Contents

- [Overview](#overview)
Expand Down
1 change: 1 addition & 0 deletions packages/ibm-products/src/components/DelimitedList/DelimitedList.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import * as stories from './DelimitedList.stories';

export const DocsPage = () => (
<StoryDocsPage
altGuidelinesHref=""
blocks={[
{
story: stories.delimited,
Expand Down
10 changes: 6 additions & 4 deletions packages/ibm-products/src/components/DragAndDrop/DragAndDrop.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import * as stories from './DragAndDrop.stories';

# Drag and drop

[Drag and drop usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/patterns/drag-and-drop/usage/)

## Table of Contents

- [Overview](#overview)
Expand All @@ -20,10 +22,10 @@ customizing the order of columns in the Datagrid.

{/* We do provide styles for some of the drag states as detailed below. */}

{/* | | State | class |
| ---------------------- | ----------------------------------------- | ----- |
| Default draggable item | `${pkg.prefix}__draggable-item` |
| Dragging | `${pkg.prefix}__draggable-item--dragging` | | */}
{/* | | State | class | */}
{/* | ---------------------- | ----------------------------------------- | ----- | */}
{/* | Default draggable item | `${pkg.prefix}__draggable-item` | | */}
{/* | Dragging | `${pkg.prefix}__draggable-item--dragging` | | */}

## Example usage

Expand Down
6 changes: 1 addition & 5 deletions packages/ibm-products/src/components/EmptyStates/EmptyStateV2.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
deprecationNotice="This component is deprecated and will be removed in the next major version. For more information, please refer to the [Carbon docs](https://carbondesignsystem.com/patterns/empty-states-pattern/)."
Expand Down
6 changes: 1 addition & 5 deletions packages/ibm-products/src/components/EmptyStates/EmptyStates.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
/>
Expand Down
6 changes: 1 addition & 5 deletions packages/ibm-products/src/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
/>
Expand Down
6 changes: 1 addition & 5 deletions ...ges/ibm-products/src/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
/>
Expand Down
6 changes: 1 addition & 5 deletions ...ges/ibm-products/src/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
/>
Expand Down
6 changes: 1 addition & 5 deletions ...ibm-products/src/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
/>
Expand Down
6 changes: 1 addition & 5 deletions ...ts/src/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
/>
Expand Down
6 changes: 1 addition & 5 deletions ...ucts/src/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,9 @@ export default {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Error pattern usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/patterns/empty-states-pattern/',
label: 'Carbon empty pattern usage guidelines',
label: 'Carbon Empty pattern usage guidelines',
},
]}
/>
Expand Down
7 changes: 2 additions & 5 deletions packages/ibm-products/src/components/ExportModal/ExportModal.stories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@

import React, { useState, useRef } from 'react';
import { Button } from '@carbon/react';
// import styles from './_storybook-styles.scss?inline'; // import index in case more files are added later.
import { ExportModal } from '.';
// import mdx from './ExportModal.mdx';
import wait from '../../global/js/utils/wait';
import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';

Expand All @@ -18,21 +16,20 @@ export default {
component: ExportModal,
tags: ['autodocs'],
parameters: {
// styles,
docs: {
page: () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://pages.github.ibm.com/carbon/ibm-products/components/export/usage/',
label: 'Export guidelines',
label: 'Export usage guidelines',
},
{
href: 'https://www.carbondesignsystem.com/components/modal/usage',
label: 'Carbon Modal usage guidelines',
},
{
href: 'https://react.carbondesignsystem.com/?path=/docs/modal--default',
href: 'https://react.carbondesignsystem.com/?path=/docs/components-modal',
label: 'Carbon Modal documentation',
},
]}
Expand Down
6 changes: 0 additions & 6 deletions packages/ibm-products/src/components/ExportModal/_storybook-styles.scss
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions packages/ibm-products/src/components/ExpressiveCard/ExpressiveCard.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import * as stories from './ExpressiveCard.stories';

const DocsPage = () => (
<StoryDocsPage
altGuidelinesHref="https://pages.github.ibm.com/carbon/ibm-products/components/card/expressive-card/usage/"
blocks={[
{
story: stories.Default,
Expand Down
2 changes: 2 additions & 0 deletions packages/ibm-products/src/components/GetStartedCard/GetStartedCard.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import * as stories from './GetStartedCard.stories';

# GetStartedCard

[Get started card usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/patterns/onboarding-flows/orientation/#get-started-card)

## Table of Contents

- [Overview](#overview)
Expand Down
6 changes: 6 additions & 0 deletions packages/ibm-products/src/components/Guidebanner/Guidebanner.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ import * as stories from './Guidebanner.stories';

export const DocsPage = () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://pages.github.ibm.com/carbon/ibm-products/components/onboarding/guide-banner/usage/',
label: 'Guide banner usage guidelines',
Comment thread
elycheea marked this conversation as resolved.
},
]}
blocks={[
{
story: stories.collapsible,
Expand Down
2 changes: 1 addition & 1 deletion packages/ibm-products/src/components/ImportModal/ImportModal.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const DocsPage = () => {
label: 'Carbon Modal usage guidelines',
},
{
href: 'https://react.carbondesignsystem.com/?path=/docs/modal--default',
href: 'https://react.carbondesignsystem.com/?path=/docs/components-modal',
label: 'Carbon Modal documentation',
},
]}
Expand Down
6 changes: 6 additions & 0 deletions packages/ibm-products/src/components/InlineTip/InlineTip.docs-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ import * as stories from './InlineTip.stories';

const DocsPage = () => (
<StoryDocsPage
altGuidelinesHref={[
{
href: 'https://pages.github.ibm.com/carbon/ibm-products/components/onboarding/inline-tip/usage/',
label: 'Inline tip usage guidelines',
},
]}
blocks={[
{
story: stories.inlineTip,
Expand Down
2 changes: 2 additions & 0 deletions packages/ibm-products/src/components/InterstitialScreen/InterstitialScreen.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { InterstitialScreen } from '.';

# InterstitialScreen

[InterstitialScreen usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/components/onboarding/interstitial-screen/)

## Table of Contents

- [Overview](#overview)
Expand Down
Loading