Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mdx template for the Storybook documentation of the design system elements #40

Closed
MellyGray opened this issue Mar 28, 2023 · 1 comment · Fixed by #46
Closed

Add mdx template for the Storybook documentation of the design system elements #40

MellyGray opened this issue Mar 28, 2023 · 1 comment · Fixed by #46
Assignees
Labels
D: Design System Deliverable: Design System MVP Milestone 2 MVP Milestone 2: Add a Dataset pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours.

Comments

@MellyGray
Copy link
Contributor

MellyGray commented Mar 28, 2023

Overview of the Feature Request

To provide the documentation of the design system we will be using the Storybook docs capabilities. Then, we'll need to create a template for the docs in .mdx format. This template is intended to be used with the design system elements, not necessary for the rest of the components of the SPA.

The current style guide could be a reference for this documentation. As well as other public Storybook:

What kind of user is the feature intended for?

Developers and contributors

What inspired the request?

The analysis of the Design System elements.

What existing behavior do you want changed?

None

Any brand new behavior do you want to add to Dataverse?

Storybook documentation template for the design system elements

Any open or closed issues related to this feature request?

@MellyGray MellyGray added Size: 10 A percentage of a sprint. 7 hours. NIH OTA: 1.7.1 (reArchitecture) MVP Milestone 2 MVP Milestone 2: Add a Dataset D: Design System Deliverable: Design System labels Mar 28, 2023
@MellyGray MellyGray moved this to Re-arch: SPA MVP (Guillermo) in IQSS Dataverse Project Mar 28, 2023
@mreekie mreekie moved this from Re-arch: SPA MVP (Guillermo) to SPRINT READY in IQSS Dataverse Project Mar 29, 2023
@mreekie
Copy link

mreekie commented Mar 29, 2023

Grooming:

  • Talked with Melina prior to the kickoff.
  • This is one of 3 issues she let me know were already sized and that would be worked in this sprint.
  • Moving them to the right columns in the backlog and sprint board.

@MellyGray MellyGray self-assigned this Mar 29, 2023
@MellyGray MellyGray linked a pull request Apr 4, 2023 that will close this issue
@mreekie mreekie moved this from SPRINT READY to Clear of the Backlog in IQSS Dataverse Project Apr 7, 2023
@mreekie mreekie added pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows and removed NIH OTA: 1.7.1 (reArchitecture) labels Apr 10, 2023
@mreekie mreekie linked a pull request May 9, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D: Design System Deliverable: Design System MVP Milestone 2 MVP Milestone 2: Add a Dataset pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours.
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

2 participants