Round 5: update broken links in update and AI docs
What does this MR do?
As part of the monthly chore list, update more broken or redirecting links.
Related issues
Related to technical-writing#1006
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
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 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 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 %16.10
assigned to @aqualls
- Resolved by Suzanne Selhorn
I'll send this one over to @sselhorn because so many Google links in the AI pages were changed.
Trying to keep these small and simple to review.
requested review from @sselhorn
removed review request for @sselhorn
2 Messages This MR contains docs in the /doc/development directory, but any Maintainer (other than the author) can merge. You do not need tech writer review. 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/update/plan_your_upgrade.md
(Link to current live version) -
doc/update/upgrading_from_source.md
(Link to current live version) -
doc/user/project/repository/code_suggestions/data.md
(Link to current live version) -
doc/user/ai_features.md
(Link to current live version)
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 User-
added docs-only label
requested review from @sselhorn
- A deleted user
added development guidelines label
- Resolved by Suzanne Selhorn
enabled an automatic merge when the pipeline for c611db56 succeeds
LGTM @aqualls Merging, thanks.
mentioned in commit 9f6253e1
added workflowstaging-canary label