Updated nav guidance for 14.0 changes
What does this MR do?
This MR updates the guidance for how we refer to menu items, now that Projects, Groups, Admin and More will all be under an item called Menu on the top bar.
Related issues
- Related to #301143 (closed)
- Related to #333189 (closed)
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have Developer permissions or higher:
-
Ensure that the product tier badge is added to doc's h1
. -
Apply the documentation label, plus: - The corresponding DevOps stage and group labels, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Request a review from the designated Technical Writer.
-
Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.
When applicable:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add the product tier badge accordingly. -
Add GitLab's version history note(s). -
Add/update the feature flag section.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. -
Ensure docs metadata are present and up-to-date. -
Ensure Technical Writing and documentation are added. -
Add the corresponding docs::
scoped label. -
If working on UI text, add the corresponding UI Text
scoped label. -
Add twdoing when starting work on the MR. -
Add twfinished if Technical Writing team work on the MR is complete but it remains open.
-
For more information about labels, see Technical Writing workflows - Labels.
For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:
- Clear typos, like
this is a typpo
. - Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
For more information, see our documentation on Merging a merge request.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Merge request reports
Activity
changed milestone to %14.0
added Documentation guidelines Technical Writing documentation labels
requested review from @cnorris
assigned to @sselhorn
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/development/documentation/styleguide/index.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger- Resolved by Craig Norris
@gl-docsteam The Projects, Groups, More, and Admin menu items on the top bar are moving into a single menu in 14.0. (Amy brought this up in a meeting a few months ago.) See this related issue.
This MR proposes some new language for how we write about these things. It's a decent-sized change. Please take a look and see what you think.
Craig and I came up with these guidelines, and as we went back in forth between "From this menu" and "In this menu" we went to the MS style guide for guidance and came back with "On this menu."
https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/f/from-vs-on
Please take a look and let us know if you have any objections. Thanks!
added tw-style label
added docsimprovement label
mentioned in issue #333189 (closed)
@sselhorn - Approved and merged.
mentioned in commit d6b93e31
added workflowstaging label
added workflowcanary label and removed workflowstaging label
added workflowproduction label and removed workflowcanary label
added releasedcandidate label
mentioned in merge request !64320 (merged)
added releasedpublished label and removed releasedcandidate label
added typemaintenance label
mentioned in merge request !125535 (merged)