Reuse alerts component for the todo (admonition) sections within the design system documentation
Problem
At the moment, the design system is inserting a placeholder for indicating work-in-progress or to do items.
At the moment, the design system is inserting a custom placeholder for indicating work-in-progress or to do items.
Todo in Components | Todo in Foundations |
---|---|
Background
- There was a proposal for extending GitLab Flavored Markdown (GFM) to support block-styled side content in https://gitlab.com/gitlab-org/gitlab-ce/issues/52181 which was also added in https://gitlab.com/gitlab-org/design.gitlab.com/issues/123. However, the suggested extension is based on mkdocs.
- There is already a Pajamas component (alerts) that resembles this functionality.
- Recently, GitLab Docs added Pajamas alerts styling for block-styled side content in https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/481.
Proposal
Following the discussion in https://gitlab.com/gitlab-org/design.gitlab.com/issues/123#note_178572771, let's do one of the following:
- Reuse Pajamas alerts for the todo (admonition) section within the design system documentation.
-
Improve the current todo sections and provide two or more variants for indicating work-in-progress, to do items, and more.This is currently implemented in https://gitlab.com/gitlab-org/design.gitlab.com/merge_requests/1461.
Edited by Taurie Davis