Skip to content

feat(Forms): Add docs for input description text

Becka Lippert requested to merge beckalippert-master-patch-53383 into master

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?

Links

#642 (closed) #723 (closed)

Edited by Jeremy Elder

Merge request reports