From 7da8bdd6566f3bc6dc8235db13207923f13c609c Mon Sep 17 00:00:00 2001 From: Alan Greene Date: Mon, 22 Jul 2024 16:09:17 +0100 Subject: [PATCH] Update Storybook welcome page links to point to Carbon v11 --- .storybook/Welcome.mdx | 14 +++++++------- packages/components/README.md | 2 +- packages/graph/README.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.storybook/Welcome.mdx b/.storybook/Welcome.mdx index cd1c0ff78..4d33f5782 100644 --- a/.storybook/Welcome.mdx +++ b/.storybook/Welcome.mdx @@ -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 @@ -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. @@ -63,16 +63,16 @@ import tektonDashboardLogo from '../src/images/tekton-dashboard-color.svg'; { process.env.NODE_ENV === 'development' && (

- 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.

) } 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 diff --git a/packages/components/README.md b/packages/components/README.md index d0adf0755..6e8364c2d 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -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. diff --git a/packages/graph/README.md b/packages/graph/README.md index a60585362..cd46c390a 100644 --- a/packages/graph/README.md +++ b/packages/graph/README.md @@ -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.