Skip to content

Commit

Permalink
fix(novice-to-pro): change to onboarding and added getStartedCard (#5422
Browse files Browse the repository at this point in the history
)

* fix(novice-to-pro): change to onboarding and added getStartedCard

* fix(checklist): typo

* fix(avt): updates

* fix(getStarted): avt
  • Loading branch information
ariellalgilmore committed Jun 11, 2024
1 parent dc4a98a commit 7442150
Show file tree
Hide file tree
Showing 46 changed files with 69 additions and 72 deletions.
2 changes: 1 addition & 1 deletion e2e/components/Checklist/Checklist-test.avt.e2e.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test.describe('Checklist @avt', () => {
test('@avt-default-state', async ({ page }) => {
await visitStory(page, {
component: 'Checklist',
id: 'ibm-products-novice-to-pro-checklist--checklist',
id: 'ibm-products-onboarding-checklist--checklist',
globals: {
carbonTheme: 'white',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ test.describe('GetStartedCard @avt', () => {
await visitStory(page, {
component: 'GetStartedCard',
// cspell:disable-next-line
id: 'ibm-products-components-cards-getstartedcard--default',
id: 'ibm-products-onboarding-getstartedcard--default',
globals: {
carbonTheme: 'white',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test.describe('Guidebanner @avt', () => {
test('@avt-collapsible-state', async ({ page }) => {
await visitStory(page, {
component: 'Guidebanner',
id: 'ibm-products-novice-to-pro-guidebanner--collapsible',
id: 'ibm-products-onboarding-guidebanner--collapsible',
globals: {
carbonTheme: 'white',
},
Expand Down
2 changes: 1 addition & 1 deletion e2e/components/InlineTip/InlineTip-test.avt.e2e.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test.describe('InlineTip @avt', () => {
test('@avt-default-state', async ({ page }) => {
await visitStory(page, {
component: 'InlineTip',
id: 'ibm-products-novice-to-pro-inline-tip-inlinetip--inline-tip',
id: 'ibm-products-onboarding-inline-tip-inlinetip--inline-tip',
globals: {
carbonTheme: 'white',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test.describe('InterstitialScreen @avt', () => {
test('@avt-full-screen-state', async ({ page }) => {
await visitStory(page, {
component: 'InterstitialScreen',
id: 'ibm-products-novice-to-pro-interstitial-screen-interstitialscreen--interstitial-screen-full-screen-image',
id: 'ibm-products-onboarding-interstitial-screen-interstitialscreen--interstitial-screen-full-screen-image',
globals: {
carbonTheme: 'white',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test.describe('InterstitialScreenView @avt', () => {
test('@avt-default-state', async ({ page }) => {
await visitStory(page, {
component: 'InterstitialScreenView',
id: 'ibm-products-novice-to-pro-interstitial-screen-interstitialscreenview--interstitial-screen-view',
id: 'ibm-products-onboarding-interstitial-screen-interstitialscreenview--interstitial-screen-view',
globals: {
carbonTheme: 'white',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test.describe('InterstitialScreenViewModule @avt', () => {
test('@avt-default-state', async ({ page }) => {
await visitStory(page, {
component: 'InterstitialScreenViewModule',
id: 'ibm-products-novice-to-pro-interstitial-screen-interstitialscreenviewmodule--interstitial-screen-view-module',
id: 'ibm-products-onboarding-interstitial-screen-interstitialscreenviewmodule--interstitial-screen-view-module',
globals: {
carbonTheme: 'white',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test.describe('NonLinearReading @avt', () => {
test('@avt-default-state', async ({ page }) => {
await visitStory(page, {
component: 'NonLinearReading',
id: 'ibm-products-novice-to-pro-non-linear-reading-nonlinearreading--single-level',
id: 'ibm-products-onboarding-non-linear-reading-nonlinearreading--single-level',
globals: {
carbonTheme: 'white',
},
Expand Down
2 changes: 1 addition & 1 deletion packages/core/.storybook/preview.js
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ const parameters = {
'Overview',
['Welcome', 'Getting started', 'Examples', '*'],
'IBM Products',
['Components', 'Patterns', 'Internal', 'Novice to pro'],
['Components', 'Patterns', 'Internal', 'Onboarding'],
'Community',
],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ $block-class: #{c4p-settings.$pkg-prefix}--non-linear-reading;
padding: $spacing-03 $spacing-04;
border-left: to-rem(1.25px) solid $text-primary;
margin: $spacing-02 0;
// Novice to pro does not always use Carbon defaults/tokens
// Onboarding does not always use Carbon defaults/tokens
// stylelint-disable-next-line carbon/motion-duration-use, carbon/motion-easing-use
animation: fade 600ms;

Expand Down
2 changes: 1 addition & 1 deletion packages/ibm-products/carbon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ assets:
- type: storybook
name: Storybook
action: link
url: https://ibm-products.carbondesignsystem.com/?path=/story/ibm-products-novice-to-pro-checklist--checklist
url: https://ibm-products.carbondesignsystem.com/?path=/story/ibm-products-onboarding-checklist--checklist
tags:
- content-block
combo-button:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ export const carousel = Template.bind({});
carousel.args = {
children: (
<>
Carousel is a <em>Novice to Pro</em> internal component and is not
intended for general use.
Carousel is an <em>Onboarding</em> internal component and is not intended
for general use.
</>
),
};
2 changes: 1 addition & 1 deletion packages/ibm-products/src/components/Carousel/Carousel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ const defaults = {
};

/**
* The Carousel acts as a scaffold for other Novice to Pro content.
* The Carousel acts as a scaffold for other Onboarding content.
*
* This component is not intended for general use.
*
Expand Down
6 changes: 3 additions & 3 deletions packages/ibm-products/src/components/Checklist/Checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as CheckListStories from './Checklist.stories';
## Table of Contents

- [Overview](#overview)
- [About Novice to pro](#about-novice-to-pro)
- [About Onboarding](#about-onboarding)
- [Example usage](#example-usage)
- [Component API](#component-api)

Expand All @@ -18,9 +18,9 @@ The Checklist tracks a user's progress much like Your Learning or WalkMe. Each
item in the list can be clickable, and each item has an icon that defines the
item's state as "not started", "in progress", and "complete".

## About Novice to pro
## About Onboarding

[Novice to pro](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/novice-to-pro/overview/)
[Onboarding](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/onboarding/overview/)
is a continuous learning methodology and framework that aims to orient, onboard,
explain, educate, and cultivate novice users into high-functioning power users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ const taskLists = [
];

export default {
title: 'IBM Products/Novice to pro/Checklist',
title: 'IBM Products/Onboarding/Checklist',
component: Checklist,
tags: ['autodocs'],
argTypes: {
Expand Down
6 changes: 3 additions & 3 deletions packages/ibm-products/src/components/Coachmark/Coachmark.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import * as CoachmarkStories from './Coachmark.stories';
## Table of Contents

- [Overview](#overview)
- [About Novice to pro](#about-novice-to-pro)
- [About Onboarding](#about-onboarding)
- [Note on theming](#note-on-theming)
- [Overview](#overview)
- [Tooltip example usage](#tooltip-example-usage)
Expand All @@ -33,9 +33,9 @@ understand.
- BEACON_KIND, COACHMARK_OVERLAY_KIND, COACHMARK_ALIGNMENT are enums exported as
a convenience from Coachmark.

## About Novice to pro
## About Onboarding

[Novice to pro](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/novice-to-pro/overview/)
[Onboarding](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/onboarding/overview/)
is a continuous learning methodology and framework that aims to orient, onboard,
explain, educate, and cultivate novice users into high-functioning power users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import mdx from './Coachmark.mdx';
import styles from './_storybook-styles.scss?inline';

export default {
title: 'IBM Products/Novice to pro/Coachmark',
title: 'IBM Products/Onboarding/Coachmark',
component: Coachmark,
tags: ['autodocs'],
argTypes: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ interface CoachmarkDragbarProps {

/**
* DO NOT USE. This component is for the exclusive use
* of other Novice to Pro components.
* of other Onboarding components.
*/
export let CoachmarkDragbar = React.forwardRef<
HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ interface CoachmarkHeaderProps {

/**
* DO NOT USE. This component is for the exclusive use
* of other Novice to Pro components.
* of other Onboarding components.
*/
export let CoachmarkHeader = React.forwardRef<
HTMLElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ type StyledTune = {

/**
* DO NOT USE. This component is for the exclusive use
* of other Novice to Pro components.
* of other Onboarding components.
*/
export let CoachmarkOverlay = forwardRef<HTMLDivElement, CoachmarkOverlayProps>(
(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ interface CoachmarkTaglineProps {

/**
* DO NOT USE. This component is for the exclusive use
* of other Novice to Pro components.
* of other Onboarding components.
*/
export let CoachmarkTagline = React.forwardRef<
HTMLDivElement,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as CoachmarkBeaconStories from './CoachmarkBeacon.stories';
## Table of Contents

- [Overview](#overview)
- [About Novice to pro](#about-novice-to-pro)
- [About Onboarding](#about-onboarding)
- [Note on theming](#note-on-theming)
- [Example usage](#example-usage)
- [Code Sample](#code-sample)
Expand All @@ -22,9 +22,9 @@ use a pulsing action to call a user’s attention to a specific area in the UI.
The `target` prop of the Coachmark should always be either a CoachmarkBeacon or
a CoachmarkButton.

## About Novice to pro
## About Onboarding

[Novice to pro](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/novice-to-pro/overview/)
[Onboarding](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/onboarding/overview/)
is a continuous learning methodology and framework that aims to orient, onboard,
explain, educate, and cultivate novice users into high-functioning power users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ import styles from './_storybook-styles.scss?inline';
import { BEACON_KIND } from '../Coachmark/utils/enums';

export default {
title:
'IBM Products/Novice to pro/Coachmark/Coachmark elements/CoachmarkBeacon',
title: 'IBM Products/Onboarding/Coachmark/Coachmark elements/CoachmarkBeacon',
component: CoachmarkBeacon,
tags: ['autodocs'],
// TODO: Define argTypes for props not represented by standard JS types.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ import mdx from './CoachmarkButton.mdx';
import styles from './_storybook-styles.scss?inline';

export default {
title:
'IBM Products/Novice to pro/Coachmark/Coachmark elements/CoachmarkButton',
title: 'IBM Products/Onboarding/Coachmark/Coachmark elements/CoachmarkButton',
component: CoachmarkButton,
tags: ['autodocs'],
// TODO: Define argTypes for props not represented by standard JS types.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as CoachmarkFixedStories from './CoachmarkFixed.stories';
## Table of Contents

- [Overview](#overview)
- [About Novice to pro](#about-novice-to-pro)
- [About Onboarding](#about-onboarding)
- [Note on theming](#note-on-theming)
- [Example usage](#example-usage)
- [Component API](#component-api)
Expand All @@ -21,9 +21,9 @@ loads. It starts in a minimized state, to cover as little of the UI as possible;
when shown in tests as expanded by default, users immediately closed it without
reading, to get it out of the way. When dismissed, it slides down off the page.

## About Novice to pro
## About Onboarding

[Novice to pro](https://pages.github.ibm.com/security/security-design/teams-across-security/novice-to-pro/overview/)
[Onboarding](https://pages.github.ibm.com/security/security-design/teams-across-security/onboarding/overview/)
is a continuous learning methodology and framework that aims to orient, onboard,
explain, educate, and cultivate novice users into high-functioning power users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import mdx from './CoachmarkFixed.mdx';
import styles from './_storybook-styles.scss?inline';

export default {
title: 'IBM Products/Novice to pro/Coachmark/CoachmarkFixed',
title: 'IBM Products/Onboarding/Coachmark/CoachmarkFixed',
component: CoachmarkFixed,
tags: ['autodocs'],
// TODO: Define argTypes for props not represented by standard JS types.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as CoachmarkOverlayElementStories from './CoachmarkOverlayElement.stori
## Table of Contents

- [Overview](#overview)
- [About Novice to pro](#about-novice-to-pro)
- [About Onboarding](#about-onboarding)
- [Note on theming](#note-on-theming)
- [Example usage](#example-usage)
- [Code Sample](#code-sample)
Expand All @@ -24,9 +24,9 @@ CoachmarkOverlayElements. When more than one CoachmarkOverlayElement components
are used in a CoachmarkOverlayElements, the components are displayed in a
paginated fashion within a carousel.

## About Novice to pro
## About Onboarding

[Novice to pro](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/novice-to-pro/overview/)
[Onboarding](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/onboarding/overview/)
is a continuous learning methodology and framework that aims to orient, onboard,
explain, educate, and cultivate novice users into high-functioning power users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import styles from './_storybook-styles.scss?inline';

export default {
title:
'IBM Products/Novice to pro/Coachmark/Coachmark elements/CoachmarkOverlayElement',
'IBM Products/Onboarding/Coachmark/Coachmark elements/CoachmarkOverlayElement',
component: CoachmarkOverlayElement,
tags: ['autodocs'],
argTypes: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as CoachmarkOverlayElementsStories from './CoachmarkOverlayElements.sto
## Table of Contents

- [Overview](#overview)
- [About Novice to pro](#about-novice-to-pro)
- [About Onboarding](#about-onboarding)
- [Note on theming](#note-on-theming)
- [Example usage](#example-usage)
- [Code Sample](#code-sample)
Expand All @@ -23,9 +23,9 @@ components as children. When more than one CoachmarkOverlayElement component is
used in a CoachmarkOverlayElements, the components are displayed in a paginated
fashion within a carousel.

## About Novice to pro
## About Onboarding

[Novice to pro](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/novice-to-pro/overview/)
[Onboarding](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/onboarding/overview/)
is a continuous learning methodology and framework that aims to orient, onboard,
explain, educate, and cultivate novice users into high-functioning power users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import styles from './_storybook-styles.scss?inline';

export default {
title:
'IBM Products/Novice to pro/Coachmark/Coachmark elements/CoachmarkOverlayElements',
'IBM Products/Onboarding/Coachmark/Coachmark elements/CoachmarkOverlayElements',
component: CoachmarkOverlayElements,
tags: ['autodocs'],
argTypes: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as CoachmarkStackStories from './CoachmarkStack.stories';
## Table of Contents

- [Overview](#overview)
- [About Novice to pro](#about-novice-to-pro)
- [About Onboarding](#about-onboarding)
- [Note on theming](#note-on-theming)
- [Example usage](#example-usage)
- [Component API](#component-api)
Expand All @@ -26,9 +26,9 @@ When dismissed, the stacked layer exits by sliding back down, revealing the main
layer. When the main layer is dismissed, it slides down off the page. Only one
layer can be stacked on the main layer.

## About Novice to pro
## About Onboarding

[Novice to pro](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/novice-to-pro/overview)
[Onboarding](https://pages.github.ibm.com/security/security-design/department/end-to-end-experiences/onboarding/overview)
is a continuous learning methodology and framework that aims to orient, onboard,
explain, educate, and cultivate novice users into high-functioning power users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import mdx from './CoachmarkStack.mdx';
import styles from './_storybook-styles.scss?inline';

export default {
title: 'IBM Products/Novice to pro/Coachmark/CoachmarkStack',
title: 'IBM Products/Onboarding/Coachmark/CoachmarkStack',
component: CoachmarkStack,
tags: ['autodocs'],
// TODO: Define argTypes for props not represented by standard JS types.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const componentName = 'CoachmarkStackHome';

/**
* DO NOT USE. This component is for the exclusive use
* of other Novice to Pro components.
* of other Onboarding components.
*/
export let CoachmarkStackHome = forwardRef(
(
Expand Down Expand Up @@ -58,7 +58,7 @@ export let CoachmarkStackHome = forwardRef(

if (!navLinkLabels) {
return pconsole.warn(
`${componentName} is a Novice to Pro internal component and is not intended for general use.`
`${componentName} is an Onboarding internal component and is not intended for general use.`
);
}

Expand Down
Loading

0 comments on commit 7442150

Please sign in to comment.