Added details about pages not in the nav
What does this MR do?
Lately we've been doing some cleanup of pages not in the global nav. (Actually, this process has been ongoing.)
We want all pages to be in the nav unless there is a strong reason not to include them.
At some point we might automate this process, but for now, this MR starts to add guidance so eventually we can automate the process.
Related issues
Related to: gitlab-docs#1212 (closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.
Merge request reports
Activity
changed milestone to %15.3
added docsimprovement documentation typemaintenance labels
assigned to @sselhorn
Suggested Reviewers (beta)
The individuals below may be good candidates to participate in the review based on various factors.
You can use slash commands in comments to quickly assign
/assign_reviewer @user1
.Suggested Reviewers @psimyn
,@aqualls
,@marcel.amirault
,@jivanvl
,@eread
If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue:
https://gitlab.com/gitlab-org/gitlab/-/issues/357923
.Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".
1 Warning Please add a merge request subtype to this merge request. 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/site_architecture/global_nav.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
DangerEdited by Ghost Useradded Documentation guidelines Technical Writing labels
requested review from @rdickenson
- Resolved by Suzanne Selhorn
Hi @rdickenson Based on the discussion we had in the meeting, would you give this MR a first look? Then I'll open it to the wider team. (Sorry we didn't get a chance to vocalize your comments during the meeting!)
- Resolved by Suzanne Selhorn
- Resolved by Suzanne Selhorn
mentioned in issue gitlab-docs#1220 (closed)
- Resolved by Suzanne Selhorn
- Resolved by Suzanne Selhorn
- Resolved by Suzanne Selhorn
- Resolved by Suzanne Selhorn
- Resolved by Suzanne Selhorn