Skip to content

Commit

Permalink
Update Storybook welcome page links to point to Carbon v11
Browse files Browse the repository at this point in the history
  • Loading branch information
AlanGreene authored and tekton-robot committed Jul 23, 2024
1 parent f81a25e commit 7da8bdd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions .storybook/Welcome.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{/*
Copyright 2023 The Tekton Authors
Copyright 2023-2024 The Tekton Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Expand Down Expand Up @@ -46,7 +46,7 @@ import tektonDashboardLogo from '../src/images/tekton-dashboard-color.svg';

### Overview

Tekton Dashboard uses the [Carbon Design System](https://v10.carbondesignsystem.com/) to guide its design, leveraging many of the base components it provides. Tekton Dashboard also publishes a number of its own npm packages containing additional components and utilities used to build on top of these.
Tekton Dashboard uses the [Carbon Design System](https://carbondesignsystem.com/) to guide its design, leveraging many of the base components it provides. Tekton Dashboard also publishes a number of its own npm packages containing additional components and utilities used to build on top of these.

This Storybook showcases each of the published UI components, including examples of variants or customisation where applicable. You can find more details in the following sections.

Expand All @@ -63,16 +63,16 @@ import tektonDashboardLogo from '../src/images/tekton-dashboard-color.svg';
{
process.env.NODE_ENV === 'development' && (
<p>
The Carbon storybook can be found at the bottom of the side nav when running in development mode. There are 2 versions included, Carbon v10 is the version currently used by the Dashboard. The Carbon v11 storybook is provided for reference purposes only, to help with decisions to consume new components. We will be adopting v11 in the future, but it should not be used in the Dashboard yet.
The Carbon storybook can be found at the bottom of the side nav when running in development mode. Carbon v11 is the version currently used by the Dashboard.
</p>
)
}

Useful links:
- [Carbon v10 documentation](https://v10.carbondesignsystem.com/)
- [Carbon v10 storybook](https://v7-react.carbondesignsystem.com/)
- [Colour usage](https://v10.carbondesignsystem.com/guidelines/color/usage/)
- [Icon library](https://v10.carbondesignsystem.com/guidelines/icons/library/)
- [Carbon v11 documentation](https://carbondesignsystem.com/)
- [Carbon v11 storybook](https://react.carbondesignsystem.com/)
- [Colour usage](https://carbondesignsystem.com/guidelines/color/usage/)
- [Icon library](https://carbondesignsystem.com/guidelines/icons/library/)


### Components
Expand Down
2 changes: 1 addition & 1 deletion packages/components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ yarn add @tektoncd/dashboard-components
```

You will also need to install the Carbon packages which provide the base styling and components:
- [Carbon Components React](https://v10.carbondesignsystem.com/developing/frameworks/react)
- [Carbon Components React](https://carbondesignsystem.com/developing/frameworks/react)

This package requires [Dart Sass](http://npmjs.com/package/sass) in order to
compile styles.
Expand Down
2 changes: 1 addition & 1 deletion packages/graph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ yarn add @tektoncd/dashboard-graph
```

You will also need to install the Carbon packages which provide the base styling and components:
- [Carbon Components React](https://v10.carbondesignsystem.com/developing/frameworks/react)
- [Carbon Components React](https://carbondesignsystem.com/developing/frameworks/react)

See the `@tektoncd/dashboard-components` documentation for details of setting up Sass for styling.

Expand Down

0 comments on commit 7da8bdd

Please sign in to comment.