carbon-platform icon indicating copy to clipboard operation
carbon-platform copied to clipboard

Put MDX Common Errors Page inside packages/mdx-component 's SB

Open francinelucca opened this issue 2 years ago • 5 comments

Related #1123 Once #1423 is complete, migrate mdx common errors page into SB docs

francinelucca avatar Oct 10 '22 14:10 francinelucca

import InlineError from '@/components/inline-error/inline-error'
import H2 from '@/components/markdown/h2'
import H3 from '@/components/markdown/h3'
import { UL } from '@/components/markdown/index'
import LI from '@/components/markdown/li'
import P from '@/components/markdown/p'
import FullPageError from '@/components/mdx-page/errors/full-page-error/full-page-error'
import PageDescription from '@/components/page-description/page-description'
import PageHeader from '@/components/page-header/page-header'
import { assetsNavData } from '@/data/nav-data'
import { LayoutContext } from '@/layouts/layout'

These are all the local imports in that file, do we expect all these components to be migrated? How will we handle LayoutContext and assetsNavData? 🤔
@alisonjoseph @jdharvey-ibm

francinelucca avatar Oct 10 '22 14:10 francinelucca

@francinelucca Since this page will be part of storybook, can we forego the assetsNavData and LayoutContext? The "side nav" will effectively be the storybook side bar. For the error condition components, we could include those in the mdx-components package as well in their own section in storybook. That's kind of a neat way to publicize the patterns we're using for these types of errors as well.

jharvey10 avatar Oct 11 '22 18:10 jharvey10

@jdharvey-ibm no problem from me with going without sidenav, was just going off of the design specs which has it 🤔

francinelucca avatar Oct 12 '22 14:10 francinelucca

Related: Currently, when you click a link that takes you to the common errors page, it doesn't open in a new tab. It probably should. It's an out-of-band experience from the Platform website which you'd probably want to view "in addition to" and not "instead of" the Platform page you were on.

@carbon-design-system/carbon-platform-designers does that change make sense to all of you?

Example page

jharvey10 avatar Oct 12 '22 19:10 jharvey10

Hey team! Please add your planning poker estimate with Zenhub @andreancardona @francinelucca

jharvey10 avatar Oct 13 '22 15:10 jharvey10