Document how to create drawer content
Related to: #365287 (closed)
Pajamas gives some guidance about docs in drawers. https://design.gitlab.com/components/drawer/
However we need to add details for contributors and tech writers for how to author this content.
It should be pretty straightforward:
- Create a markdown doc in the
/doc/drawers
folder in the gitlab project - Use heading titles and text as usual
- Confirm that the text appears correctly in the drawer
As we learn more we can give guidance on word counts that fit in the drawer.
Also need guidance on when to link from a drawer to the product docs.
Also, drawer content is going to break SSOT. We are not going to share topics from docs.gitlab.com with the drawers. This is partly because the rendered content uses GitLab Flavored Markdown (GLFM). This markdown does not support the styles we use for version bullets, tier badges, and alert boxes, among other things.
In the metadata, type: drawer
.
Also in the metadata, should we attempt to note the page where the drawer is displayed?
File names - what's the standard?
These docs cannot have:
- Tier badges
- Version history text
- Alert boxes
- Other? Links? What other custom styling do we have?
SARAH or AXIL: We will need to exclude files in the /drawers
directory from being included in the docs site build.