Make the punctuation of the help text part of the link
What does this MR do?
Basically include the period of the Learn more.
text in the link.
During the work we've been doing by refactoring the UI text, there's a lot of help links that we touch.
The current guidelines mention two methods of help text:
- Use a question to lead the user to helpful information.
- Example: User cohorts show how active users are in the last 12 months. What kind of information is available?
- If a question doesn’t make sense, use the sentence, “Learn more.” Do not use “More information” or other phrases, and always use a period.
- Example: User cohorts show how active users are in the last 12 months. Learn more.
Since the first method includes the question mark in the link, why not do the same for the period in the second method?
Does this MR meet the acceptance criteria?
-
The MR title and commit message meet the Pajamas commit conventions -
Add a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what -
Include MR scope that reflects the purpose of the change in the description - For example, if this MR is focused on
usage guidelines
, addressingaccessibility challenges
could be added separately with a different MR
- For example, if this MR is focused on
-
If creating a new page on Pajamas from scratch, follow the page template structure -
Follow the Pajamas Voice & Tone Guidelines and GitLab Documentation Style Guide -
Link components to and from other related components and patterns on the .md
file, where helpful -
If embedding a Figma file, follow the Figma embed guide -
Assign it to a reviewer. All GitLab designers are reviewers, but you can also assign it directly to a maintainer or trainee maintainer -
Apply the correct component label(s) -
Select a milestone or due date
Links
Edited by Achilleas Pipinellis