Consolidate version history and availability details (version 2)
What does this MR do and why?
Updates styling and layout for feature availability info (formerly badges).
See #1751 (comment 1736745246).
Screenshots, screen recordings, or links to review app
Before | After |
---|---|
Example pages:
- Tier and offering info only
- Version history only
- https://1751-feature-details-v3.docs.gitlab-review.app/ee/administration/auth/ldap/ldap_synchronization.html#user-sync
- https://1751-feature-details-v3.docs.gitlab-review.app/ee/administration/instance_limits.html#deprecated-api-endpoints
- https://1751-feature-details-v3.docs.gitlab-review.app/ee/administration/instance_limits.html#search-rate-limit
- Both tier/offering + version history
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
-
Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md. -
Add a test page (you can put this in content/testpage.md
and view it athttp://localhost:3000/testpage.html
) with the proposed markdown update. You can use this example markdown (available as a snippet here as well):
Test page content
# Has availability info, multiple history items
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** Self-managed
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85689) in GitLab 15.0 [with a flag](../administration/feature_flags.md) named `inactive_projects_deletion`. Disabled by default.
> - [Feature flag `inactive_projects_deletion`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96803) removed in GitLab 15.4.
> - Configuration through GitLab UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85575) in GitLab 15.1.
## Has availability info, single history item
DETAILS:
**Tier:** GitLab.com, self-managed, Dedicated
**Offering:** Ultimate, Duo Enterprise add-on
**Status:** Beta
> [First GitLab Duo features introduced](https://about.gitlab.com/blog/2023/05/03/gitlab-ai-assisted-features/) in GitLab 16.0.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce volutpat rhoncus metus, non convallis arcu. Sed iaculis tellus eget ex consequat efficitur. Etiam mi metus, ullamcorper ac pulvinar sed, aliquam sit amet mi.
Nullam vestibulum eget orci ac dignissim. Aenean rhoncus efficitur luctus. Fusce id fringilla ipsum, a mollis orci. Ut luctus nulla maximus nisl suscipit euismod. Donec finibus, lectus venenatis iaculis accumsan, leo metus finibus nulla, vitae finibus orci purus non lectus.
Aliquam ac pulvinar enim, ut semper risus. Fusce suscipit urna non lectus faucibus, vel malesuada nisl convallis. Duis sed ullamcorper lorem, ut accumsan sapien.
## Availability info only
DETAILS:
**Tier:** GitLab.com, self-managed, Dedicated
**Offering:** Ultimate, Duo Enterprise add-on
Aliquam ac pulvinar enim, ut semper risus. Fusce suscipit urna non lectus faucibus, vel malesuada nisl convallis. Duis sed ullamcorper lorem, ut accumsan sapien.
## Multiple version history items, no availability info
> - [First GitLab Duo features introduced](https://about.gitlab.com/blog/2023/05/03/gitlab-ai-assisted-features/) in GitLab 16.0.
> - [First GitLab Duo features introduced](https://about.gitlab.com/blog/2023/05/03/gitlab-ai-assisted-features/) in GitLab 16.0.
Aliquam ac pulvinar enim, ut semper risus. Fusce suscipit urna non lectus faucibus, vel malesuada nisl convallis. Duis sed ullamcorper lorem, ut accumsan sapien.
## Single version history, no availability info
> [First GitLab Duo features introduced](https://about.gitlab.com/blog/2023/05/03/gitlab-ai-assisted-features/) in GitLab 16.0.
Nullam vestibulum eget orci ac dignissim. Aenean rhoncus efficitur luctus. Fusce id fringilla ipsum, a mollis orci. Ut luctus nulla maximus nisl suscipit euismod. Donec finibus, lectus venenatis iaculis accumsan, leo metus finibus nulla, vitae finibus orci purus non lectus.
Aliquam ac pulvinar enim, ut semper risus. Fusce suscipit urna non lectus faucibus, vel malesuada nisl convallis. Duis sed ullamcorper lorem, ut accumsan sapien.
-
Verify feature availability details (tier/offering/status) and version history display correctly with the different possible combinations.
Merge request acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this merge request.
Closes #1751 (closed)
Edited by Sarah German