Standardise in-UI help text and links to documentation
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
At present the GitLab UI is inconsistent in providing in-UI help text. The methods currently in use include:
- No help text at all.
- Tooltips for individual items. <1>
- Help text below input fields. <2>
- Help text both above and below input fields. <3>
- A
❓ icon beside a label which when clicked on opens a docs page in the same tab. <4> - A
❓ icon which when clicked opens an information pane. <5>
In addition to these points:
- In those instances where the
❓ icon is used, it appears in at least two different colours. - There are screens where tooltips are used inconsistently. See below for an example.
Inconsistent usage of tooltips
Open a project page, then go to CI/CD > Pipelines.
- Badges in the Status column don't have tooltips.
- Badges in the Pipeline column have tooltips.
- The dates in the Date column (which is not labelled) have tooltips.
- The i-don't-know-what-because-they're-not-labelled things in the last column consists of 3 segments. The first 2 segments have tooltips, but the last does not.
Footnotes
<1> Open a project and hover over the notification setting (
<2> Open a project and go to General > Settings, then expand the Naming, topics, avatar section. The Topics field has help text below it.
<3> Open a project and go to General > Settings, then expand the Badges section. The Link and Badge image URL fields have help text above them, and an example below.
<4> Open an existing issue. The Related issues label features a
<5> Open an existing issue. In the right-hand pane is a Time tracking entry, which features a
/CC @tauriedavis + @pedroms