Skip to content

feat(Alert): Update guidelines for new navigation

Austin Regnery requested to merge aregnery/update-placement-guideline-for-alerts into main

What does this MR do?

The placement of alerts has been revised. Global alerts are now placed below the breadcrumb bar instead of the navigation bar. Page-level alerts are now displayed near the top of a page, directly below the heading section, rather than below the navigation bar and above the breadcrumbs.

Does this MR meet the acceptance criteria?

  • The MR title and commit messages meet the [Pajamas commit conventions][commits].
  • 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”][transparency].
    • 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.
  • If creating a new component page [from scratch][writing-documentation], it follows the [page template structure][page-template].
  • Content follows the [Pajamas voice and tone guidelines][voice-and-tone], falling back on the [GitLab Documentation Style Guide][style-guide] when needed.
  • Related pages are cross-linked, where helpful. Component pages have [related components and patterns][related] defined in their Markdown front matter.
  • If [embedding a Figma file][figma-embed], it follows the [Figma embed guide][figma-embed-guide].
  • Review requested from any [GitLab designer][design-reviewer] or directly from a [maintainer or trainee maintainer][pajamas-assignments].
  • Maintainer review follows the [Pajamas UX maintainer review checklist][pajamas-maintainer-checklist].

Links

[commits]: https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com/-/blob/main/doc/commits.md [transparency]: https://about.gitlab.com/handbook/values/#say-why-not-just-what [writing-documentation]: https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com#writing-component-documentation [page-template]: https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com/-/blob/main/pages/components/template.md [voice-and-tone]: https://design.gitlab.com/content/voice-tone [style-guide]: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html [related]: https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com/-/blob/main/pages/components/template.md#L27-36 [design-reviewer]: https://about.gitlab.com/handbook/engineering/ux/pajamas-design-system/design-review/#reviewer [pajamas-assignments]: https://about.gitlab.com/handbook/engineering/projects/#design.gitlab.com [figma-embed]: https://www.figma.com/developers/embed [figma-embed-guide]: https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com/-/blob/main/doc/figma-embed.md [pajamas-maintainer-checklist]: https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com/-/blob/main/doc/maintainer-checklist.md

Merge request reports