feat:(GlLink) Add documentation
What does this MR do?
This MR adds documentation for the GLLink. The component exists in GitLab UI but is not documented in Pajamas. I've often found myself looking for it. Instead, guidance about links is spread in different parts of the site.
There's a number of discussions going on around visual styling of links, including the underlining of links. The intention is this documentation is the foundation that we can build off of. We need to define standards about how we visually signal links and link variants and then document them here. Examples of conversations: #1041 (closed), #1266 (closed), gitlab-org/gitlab-ui#1084
For now, this MR takes the vague stance that we should try to underline links where possible (for accessibility) but does not give more specific guidance.
Question
- I'm not sure where to link to within Figma - I don' think we have a link text style - do we need to create one?
Related to: #880 (closed)
Does this MR meet the acceptance criteria?
-
The MR title and commit messages meet the Pajamas commit conventions. -
The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”. - For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
-
Relevant label(s) are applied to the MR. -
The MR is added to a milestone. -
If creating a new component page from scratch, it follows the page template structure. -
Content follows the Pajamas voice and tone guidelines, falling back on the GitLab Documentation Style Guide when needed. -
Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter. -
If embedding a Figma file, it follows the Figma embed guide. -
Review requested from any GitLab designer or directly from a maintainer or trainee maintainer.