Skip to content

Differentiate deprecation copy for components and other patterns

What does this MR do?

Differentiate deprecation copy for components and other patterns

Currently our deprecation warning says "Please refrain from using this component - it is deprecated and will be removed." This copy is a bit awkward/not relevant when the docs page in question is a pattern documentation page.

This MR introduces differentiated deprecation copy so that components will say "component" and any other page will say "pattern".

Screenshots or screen recordings

Page section Before After
component (unchanged) localhost_2018_components_infinite-scroll (1).png localhost_2018_components_infinite-scroll.png
any other section localhost_2018_patterns_duo-slash-commands (1).png localhost_2018_patterns_duo-slash-commands.png

To reproduce

  1. Run this branch of docs locally
  2. Add deprecated: true to a markdown page outside of the contents/components/ directory (For example, inside contents/patterns/)
  3. You will see that the deprecated message says pattern not component for the relevant page
  4. Visit a deprecated component page (or add deprecated: true to a component markdown page)
  5. You will see that the deprecation message still says component

Integrations

N/A

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”.
    • For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
  • Relevant label(s) are applied to the MR.
  • The MR is added to a milestone.
  • Added the ~"component:*" label(s) if applicable.
  • A changeset is added when this MR will do a patch, minor, or major update. More information can be found in doc/publishing-packages.md.

Components

  • GitLab UI's contributing guidelines.
  • If the MR changes a component's API, integration MR(s) have been opened (see integrations above).

Documentation

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.

Merge request reports

Loading