Skip to content

Commit

Permalink
fix: Fixes Broken Links from Storybook 7 Upgrade (#3065)
Browse files Browse the repository at this point in the history
Fixes: #3064  

Updating links that were broken from the Storybook 7 upgrade.

[category:Documentation]
  • Loading branch information
josh-bagwell authored Dec 10, 2024
1 parent 1f20131 commit 7f55508
Show file tree
Hide file tree
Showing 29 changed files with 179 additions and 178 deletions.
12 changes: 6 additions & 6 deletions .storybook/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,20 @@ const routes = {
'/components/text/text/': 'components-text-text--basic',
'/components/text/title/': 'components-text-title--basic',
'/examples/layout/': 'examples-layouts--area-column-positioning',
'/getting-started/for-developers/contributing/': 'guides-contributing--page',
'/getting-started/for-developers/contributing/': 'guides-contributing--docs',
'/getting-started/for-developers/resources/api-pattern-guidelines/':
'guides-api-pattern-guidelines--page',
'guides-api-pattern-guidelines--docs',
'/getting-started/for-developers/resources/collection-api/': 'features-collections--basic',
'/getting-started/for-developers/resources/compound-components/':
'guides-compound-components--page',
'guides-compound-components--docs',
'/getting-started/for-developers/resources/creating-compound-components/':
'guides-creating-compound-components--page',
'guides-creating-compound-components--docs',
'/getting-started/for-developers/resources/responsive-styling/':
'features-responsive-styling--responsive-container',
'/getting-started/for-developers/resources/style-props/':
'features-style-props--background-example',
'/getting-started/for-developers/resources/testing/': 'guides-testing--page',
'/getting-started/introduction/': 'guides-getting-started--page',
'/getting-started/for-developers/resources/testing/': 'guides-testing--docs',
'/getting-started/introduction/': 'guides-getting-started--docs',
'/tokens/color/': 'tokens--colors',
'/tokens/depth/': 'tokens--depth',
'/tokens/space/': 'tokens--space',
Expand Down
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,14 @@ The Canvas Kit core team will take a look and discuss it with you.
## Contributing

Want to contribute to Canvas Kit React? Please read our
[contributing guidelines](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--page) to find out more and how to get
started.
[contributing guidelines](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--docs)
to find out more and how to get started.

## Maintaining

If you're a Canvas Kit maintainer, please read our
[maintaining docs](https://workday.github.io/canvas-kit/?path=/docs/guides-maintaining--page) to learn more about our processes.
[maintaining docs](https://workday.github.io/canvas-kit/?path=/docs/guides-maintaining--docs) to
learn more about our processes.

## Open Development

Expand All @@ -79,7 +80,7 @@ process. Any and all issues are public and available for discussion.

Canvas Kit follows [semantic versioning](https://semver.org/) and is enforced automatically by
[conventional commits](https://www.conventionalcommits.org/) (see
["Commit Message Format"](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--page#commit-message-format)).
["Commit Message Format"](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--docs#commit-message-format)).

Each module is independently versioned using [Lerna](https://github.com/lerna/lerna).

Expand All @@ -102,8 +103,8 @@ recommend against using it in production until the first stable version has been

## Developer Documentation

- [Contributing](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--page)
- [Code of Conduct](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--page#code-of-conduct)
- [Contributing](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--docs)
- [Code of Conduct](https://workday.github.io/canvas-kit/?path=/docs/guides-contributing--docs#code-of-conduct)
- Upgrade Guides:
- [v4.0 Upgrade Guide](https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v4-0--docs)
- [v5.0 Upgrade Guide](https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v5-0--docs)
Expand All @@ -115,10 +116,10 @@ recommend against using it in production until the first stable version has been
- [v11.0 Upgrade Guide](https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v11-0--docs)
- [v12.0 Upgrade Guide](https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v12-0--docs)
- Code Style / Best Practices:
- [API & Pattern Guidelines](https://workday.github.io/canvas-kit/?path=/docs/guides-api-pattern-guidelines--page)
- [Compound Components](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--page)
- [Creating Compound Components](https://workday.github.io/canvas-kit/?path=/docs/guides-creating-compound-components--page)
- [Testing](https://workday.github.io/canvas-kit/?path=/docs/guides-testing--page)
- [API & Pattern Guidelines](https://workday.github.io/canvas-kit/?path=/docs/guides-api-pattern-guidelines--docs)
- [Compound Components](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--docs)
- [Creating Compound Components](https://workday.github.io/canvas-kit/?path=/docs/guides-creating-compound-components--docs)
- [Testing](https://workday.github.io/canvas-kit/?path=/docs/guides-testing--docs)

## License

Expand Down
2 changes: 1 addition & 1 deletion modules/docs/mdx/10.0-UPGRADE-GUIDE.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If you're using Canvas Kit and not directly using this package, there is nothing
end. The Canvas Kit packages are using the static compilation as part of the build process. If you
want to use this package for your own styles, you don't need to do anything special to use in
development; just reference our
[documentation](https://workday.github.io/canvas-kit/?path=/story/features-styling-welcome--page) on
[documentation](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started--docs) on
how to get started.

For more information on why this package was introduced, please reference our
Expand Down
14 changes: 7 additions & 7 deletions modules/docs/mdx/11.0-UPGRADE-GUIDE.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import {Meta} from '@storybook/addon-docs';
import {Table} from '@workday/canvas-kit-react/table';
import {base, brand, system} from '@workday/canvas-tokens-web';
import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
import {cssVar} from '@workday/canvas-kit-styling';
import {Box} from '@workday/canvas-kit-react/layout';
import { Meta } from '@storybook/addon-docs';
import { Table } from '@workday/canvas-kit-react/table';
import { base, brand, system } from '@workday/canvas-tokens-web';
import { StatusIndicator } from '@workday/canvas-kit-preview-react/status-indicator';
import { cssVar } from '@workday/canvas-kit-styling';
import { Box } from '@workday/canvas-kit-react/layout';

<Meta title="Guides/Upgrade Guides/v11.0" />

Expand Down Expand Up @@ -852,7 +852,7 @@ previously in [Main](#main) (for reference, see
in [Main](#main) from v9).

`Table` is a
[compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--page)
[compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--docs)
which provides a flexible API and access to its internals via its subcomponents.

> **Note**: `rowState` prop is no longer a part of the `Table` component.
Expand Down
14 changes: 7 additions & 7 deletions modules/docs/mdx/12.0-UPGRADE-GUIDE.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import {Meta} from '@storybook/addon-docs';
import {Table} from '@workday/canvas-kit-react/table';
import {base, brand, system} from '@workday/canvas-tokens-web';
import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
import {cssVar} from '@workday/canvas-kit-styling';
import {Box} from '@workday/canvas-kit-react/layout';
import { Meta } from '@storybook/addon-docs';
import { Table } from '@workday/canvas-kit-react/table';
import { base, brand, system } from '@workday/canvas-tokens-web';
import { StatusIndicator } from '@workday/canvas-kit-preview-react/status-indicator';
import { cssVar } from '@workday/canvas-kit-styling';
import { Box } from '@workday/canvas-kit-react/layout';

<Meta title="Guides/Upgrade Guides/v12.0" />

Expand Down Expand Up @@ -363,7 +363,7 @@ made to provide more flexibility and better explicit components when using input
##### Breaking API Change

The newly promoted `FormField` is a
[compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--page).
[compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--docs).
Due to the different APIs of the component, this change is **not codemodable**. The following shows
an example of how to **update** your code to match the new compound component API.

Expand Down
2 changes: 1 addition & 1 deletion modules/docs/mdx/CONTRIBUTING.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Upon commit, [lint-staged](https://github.com/okonet/lint-staged) will run your
### Releases

- Releases are prepared by updating package versions with `lerna version`, and updating the
[changelog](/docs/changelog--page)
[changelog](/docs/changelog--docs)
- A PR is created for the above updates
- After the release PR is approved and merged, we create a release in GitHub with the contents of
the changelog updates.
Expand Down
2 changes: 1 addition & 1 deletion modules/docs/mdx/welcome.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Readme from '../../../README.md';
33import Readme from '../../../README.md';
import Markdown from '../../../utils/storybook/Markdown.tsx';
import {WelcomePage} from './welcomePage';
import {InstallBlock} from './installBlock';
Expand Down
2 changes: 1 addition & 1 deletion modules/docs/mdx/welcomePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export const WelcomePage = () => {
as={Hyperlink}
alignSelf="end"
marginTop="xs"
href="https://workday.github.io/canvas-kit/?path=/docs/guides-getting-started--page"
href="https://workday.github.io/canvas-kit/?path=/docs/guides-getting-started--docs"
>
{' '}
Getting Started Guide
Expand Down
2 changes: 1 addition & 1 deletion modules/preview-react/menu/lib/Menu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export class DeprecatedMenu extends React.Component<DeprecatedMenuProps, Depreca
console.warn(
`This component is being deprecated and will be removed in a future major version.\n
For more information, please see the V8 upgrade guide:\n
https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page
https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v8-0--docs#menu-preview
`
);

Expand Down
2 changes: 1 addition & 1 deletion modules/preview-react/menu/lib/MenuItem.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ export class DeprecatedMenuItem extends React.Component<DeprecatedMenuItemProps>
console.warn(
`This component is being deprecated and will be removed in a future major version.\n
For more information, please see the V8 upgrade guide:\n
https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page
https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v8-0--docs#menu-preview
`
);
}
Expand Down
28 changes: 14 additions & 14 deletions modules/preview-react/radio/stories/Radio.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';

import {Basic} from './examples/Basic';
import {Alert} from './examples/Alert';
import {Error} from './examples/Error';
import {Inverse} from './examples/Inverse';
import {LabelPosition} from './examples/LabelPosition';
import {NoValue} from './examples/NoValue';
import {RefForwarding} from './examples/RefForwarding';
import {Disabled} from './examples/Disabled';
import {Required} from './examples/Required';
import {Custom} from './examples/Custom';
import {StandaloneRadio} from './examples/StandaloneRadio';
import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';

import { Basic } from './examples/Basic';
import { Alert } from './examples/Alert';
import { Error } from './examples/Error';
import { Inverse } from './examples/Inverse';
import { LabelPosition } from './examples/LabelPosition';
import { NoValue } from './examples/NoValue';
import { RefForwarding } from './examples/RefForwarding';
import { Disabled } from './examples/Disabled';
import { Required } from './examples/Required';
import { Custom } from './examples/Custom';
import { StandaloneRadio } from './examples/StandaloneRadio';

import * as RadioStories from './Radio.stories';

Expand Down Expand Up @@ -142,7 +142,7 @@ how to use `RadioGroup` with React Hook Form.

Radio and its subcomponents support custom styling via the `cs` prop. For more information, check
our
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).

## Component API

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';

import {Basic} from './examples/Basic';
import {Emphasis} from './examples/Emphasis';
import {Icon} from './examples/Icon';
import {Overflow} from './examples/Overflow';
import {Variants} from './examples/Variants';
import { Basic } from './examples/Basic';
import { Emphasis } from './examples/Emphasis';
import { Icon } from './examples/Icon';
import { Overflow } from './examples/Overflow';
import { Variants } from './examples/Variants';

import * as StatusIndicatorStories from './StatusIndicator.stories';

Expand Down Expand Up @@ -78,7 +78,7 @@ The background color dictated by the `variant` will be dark or light based on th

Status Indicator and its subcomponents support custom styling via the `cs` prop. For more
information, check our
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).

## Component API

Expand Down
6 changes: 3 additions & 3 deletions modules/react/_examples/stories/mdx/CompoundComponent.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {ExampleCodeBlock} from '@workday/canvas-kit-docs';
import { ExampleCodeBlock } from '@workday/canvas-kit-docs';

import {Template} from './examples/compoundComponent/CustomCard';
import { Template } from './examples/compoundComponent/CustomCard';

<Meta title="Examples/Compound Component" />

Expand All @@ -12,6 +12,6 @@ Component component utilites are a great way to wrap and extend exisitng Canvas
can dramatically simplify state handling and gives you easy access to things like ref forwarding.

For more complex examples,
[see the creating-compound-components guide](https://workday.github.io/canvas-kit/?path=/docs/guides-creating-compound-components--page).
[see the creating-compound-components guide](https://workday.github.io/canvas-kit/?path=/docs/guides-creating-compound-components--docs).

<ExampleCodeBlock code={Template} />
10 changes: 5 additions & 5 deletions modules/react/badge/stories/CountBadge.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';

import {Basic} from './examples/Basic';
import {CustomLimit} from './examples/CustomLimit';
import {NotificationBadge} from './examples/NotificationBadge';
import { Basic } from './examples/Basic';
import { CustomLimit } from './examples/CustomLimit';
import { NotificationBadge } from './examples/NotificationBadge';

import * as CountBadgeStories from './CountBadge.stories';

Expand Down Expand Up @@ -63,7 +63,7 @@ of another screen update, then this use of `AriaLiveRegion` is unnecessary and n
### Custom Styles

Count Badge supports custom styling via the `cs` prop. For more information, check our
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).

## Component API

Expand Down
28 changes: 14 additions & 14 deletions modules/react/button/stories/button/Button.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import {
ExampleCodeBlock,
Specifications,
SymbolDoc,
SymbolDescription,
ExampleCodeBlock,
Specifications,
SymbolDoc,
SymbolDescription,
} from '@workday/canvas-kit-docs';

import {Primary} from './examples/Primary';
import {PrimaryInverse} from './examples/PrimaryInverse';
import {Secondary} from './examples/Secondary';
import {SecondaryInverse} from './examples/SecondaryInverse';
import {Tertiary} from './examples/Tertiary';
import {TertiaryInverse} from './examples/TertiaryInverse';
import {Delete} from './examples/Delete';
import {Grow} from './examples/Grow';
import {CustomStyles} from './examples/CustomStyles';
import { Primary } from './examples/Primary';
import { PrimaryInverse } from './examples/PrimaryInverse';
import { Secondary } from './examples/Secondary';
import { SecondaryInverse } from './examples/SecondaryInverse';
import { Tertiary } from './examples/Tertiary';
import { TertiaryInverse } from './examples/TertiaryInverse';
import { Delete } from './examples/Delete';
import { Grow } from './examples/Grow';
import { CustomStyles } from './examples/CustomStyles';

import * as ButtonStories from './Button.stories';

Expand Down Expand Up @@ -89,7 +89,7 @@ the width of the button to the width of its container.
### Custom Styles

All of our buttons support custom styling via the `cs` prop. For more information, check our
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page)
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs)
or view the example below.

<ExampleCodeBlock code={CustomStyles} />
Expand Down
10 changes: 5 additions & 5 deletions modules/react/card/stories/card.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
import * as CardStories from './card.stories';

import {Basic} from './examples/Basic';
import {WithCustomStyles} from './examples/CustomStyles';
import {WithStencils} from './examples/Stencils';
import { Basic } from './examples/Basic';
import { WithCustomStyles } from './examples/CustomStyles';
import { WithStencils } from './examples/Stencils';

<Meta of={CardStories} />

Expand Down Expand Up @@ -33,7 +33,7 @@ yarn add @workday/canvas-kit-react
### Custom Styles

Card and its subcomponents support custom styling via the `cs` prop. For more information, check our
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).

<ExampleCodeBlock code={WithCustomStyles} />

Expand Down
28 changes: 14 additions & 14 deletions modules/react/checkbox/stories/Checkbox.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import {
ExampleCodeBlock,
SymbolDoc,
Specifications,
InformationHighlight,
ExampleCodeBlock,
SymbolDoc,
Specifications,
InformationHighlight,
} from '@workday/canvas-kit-docs';
import {Alert} from './examples/Alert';
import {Basic} from './examples/Basic';
import {Inverse} from './examples/Inverse';
import {Disabled} from './examples/Disabled';
import {Error} from './examples/Error';
import {Indeterminate} from './examples/Indeterminate';
import {LabelPosition} from './examples/LabelPosition';
import {RefForwarding} from './examples/RefForwarding';
import {Required} from './examples/Required';
import { Alert } from './examples/Alert';
import { Basic } from './examples/Basic';
import { Inverse } from './examples/Inverse';
import { Disabled } from './examples/Disabled';
import { Error } from './examples/Error';
import { Indeterminate } from './examples/Indeterminate';
import { LabelPosition } from './examples/LabelPosition';
import { RefForwarding } from './examples/RefForwarding';
import { Required } from './examples/Required';

import * as CheckboxStories from './Checkbox.stories';

Expand Down Expand Up @@ -107,7 +107,7 @@ or `Checkbox.ErrorType.Error` if Form Field is not being used.
### Custom Styles

Checkbox supports custom styling via the `cs` prop. For more information, check our
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).

## Component API

Expand Down
Loading

0 comments on commit 7f55508

Please sign in to comment.