Edit Description lists in the Content Editor
Problem to solve
In order to support the full GitLab Flavored Markdown spec, the Content Editor must be support rendering and editing all the elements of the standard implementation .
Here, we are focused on creating description (or definition) lists.
Intended users
- Parker (Product Manager)
- Presley (Product Designer)
- Sasha (Software Developer)
- Eddie (Content Editor)
User experience goal
The user should be able to create and edit description lists (with title and description) in the Content Editor.
Proposal
Create an extension for the Content Editor that supports editing description lists in the content.
An icon should be displayed in the toolbar. The toolbar icon will create a new description list from any selected text.
Details
Extensions to the Content Editor require a few specific details:
Input Rule | <dl> |
Paste Rule | [paste_rule] |
Toolbar Button | [icon] |
Keyboard Shortcut | [shortcut] |
Instrumentation | [event_name] |
Documentation
Availability & Testing
Available Tier
This feature, as with the content editor itself, is available on both SaaS and Self-managed Free tiers
What does success look like, and how can we measure that?
An event should be added to track creation of a new collapsible content nodes through the UI. We aren't interested in tracking every instance of collapsible content in existing documents, but it would be great to know how often this extension is invoked through the editor, and whether it is done by using the toolbar, keyboard shortcut, or by typing directly into the editor.