Skip to content

Updating nav and top level

Suzanne Selhorn requested to merge selhorn-plan-track-standardize into master

What does this MR do?

I wanted to make these pages build on each other, so I changed the order slightly. I also opened a related MR to update the nav to match this page.

In these screenshots you can see how in the "after," the page layout matches the left nav order.

The idea is for each page to build on the one before. So you learn how about the things that go on an issue (labels, iterations, milestones) then issues themselves, then how you populate the issues.

Then it moves on to the portfolio management features, which build on issues.

Then finally, after you know what you're doing, you can start using quick actions and build on your core knowledge.

Before After
image image

Specifically, I made these changes:

  • Reordered the groups that were already on the Plan and track work page.
  • Updated the left nav to match the order on the page.

I'm not sure where Use Git should go, but left it where it is for now.

Related issues

Related to: #384502 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Suzanne Selhorn

Merge request reports