WIP: Docs: terminology tooltips
What does this MR do?
NOTE: THIS IS A TEST FOR DEMONSTRATION PURPOSE!
Proposal
- Add tooltips or popovers to the docs to display terminology.
- Reuse information from a data file (
doc/_data/terminology.yml
).
Reason
We can explain what a term means without having to take the user to another page. It allows us to have cleaner docs but at the same time say what a term refers to.
Review app: http://docs-preview-ee-31466.178.62.207.141.nip.io/ee/test/terminology_tooltips.html
How it looks
Tooltips (display on hover) | Popovers (display on click) |
---|---|
How to do this
Through a regex/helper make it in a way we can call the term from a markdown document. For example, the markup {remote repository}
should take the data from the data file and generate the tooltip/popover:
To start working locally on an existing {remote repository}, clone it with the command `git clone <repository path>`.
To-dos
-
Decide if we want tooltips or popovers. -
Build a regex/helper to pull information from the data file so that the same information can be reused in multiple docs.
Related issues
- Relates to: &3080, !30728 (merged) (where I needed to add Git terminology somehow but didn't want to take the user away from the page).
- Add support for popovers: gitlab-docs!854 (merged)
- gitlab-docs#737 (closed)
- Request for Secure terminology: #215382 (closed)
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have
developer
access or higher (for example, GitLab team members or Core Team members)-
Apply the documentation label, plus: - The corresponding DevOps stage and group label, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Assign the designated Technical Writer.
-
When applicable:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add GitLab's version history note(s). -
Add the product tier badge. -
Add/update the feature flag section. -
If you're changing document headings, search doc/*
,app/views/*
, andee/app/views/*
for old headings replacing with the new ones to avoid broken anchors.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. -
Add Technical Writing and docs::
workflow label. -
Add docs-only when the only files changed are under doc/*
.
-
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Jean du Plessis