feat(Forms): Add docs for input description text
What does this MR do?
This MR adds documentation for the (optional) description field added to text inputs within the form component. See Text inputs: Add description field for more context. The problem it solves is that the help text didn't work for SAST Configuration UI because:
- Help text needs to be contained to the width of the input container, and we need 1-2 sentences to explain the variable
- We're using the help text for another purpose; if the user changes the variable, we need to tell them that they will be excluded from template updates, and then we apply a link to revert if they so choose
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 -
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 Jeremy Elder