feat(GlPath): update usage guidelines
What does this MR do?
With the help of @danmh, we found that the Path
component usage guidelines were changed, seemingly accidentally, when the layout of component pages was refactored. This happened at !2655 (merged). Previously, the usage guidelines were:
Do Don’t Use paths rather than tabs when there is a process with unique content at each stage, for example, a DevOps lifecycle. Nest paths. Use as an indicator of a user’s progress within a process, for example, in a checkout flow.
And after the refactoring change, the Use as an indicator of a user’s progress within a process, for example, in a checkout flow.
guideline was updated to a Do.
This MR reverts that change so that the Path component is no longer suggested to be used as an indicator of a user's progress within a process.
Out of scope of this MR: Does the path
component need to be a distinct component? Could we offer a variation of tabs instead to fit for this use case?
Does this MR meet the acceptance criteria?
-
The MR title and commit messages meet the Pajamas commit conventions. -
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. -
If creating a new component page from scratch, it follows the page template structure. -
Content follows the Pajamas voice and tone guidelines, falling back on the GitLab Documentation Style Guide when needed. -
Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter. -
If embedding a Figma file, it follows the Figma embed guide. -
Review requested from any GitLab designer or directly from a maintainer or trainee maintainer.
Links
Edited by Gina Doyle