Docs: Add use cases for linked epics
What does this MR do?
Adds use case topics to https://docs.gitlab.com/ee/user/group/epics/linked_epics.html based on Epics linked items widget - update docs with us... (#407465 - closed).
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details 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 %17.8
added docs-only documentation maintenancerefactor typemaintenance labels
assigned to @msedlakjakubowski
removed maintenancerefactor label
removed missed:17.5 label
added featureenhancement label
added twdoing workflowin dev labels and removed twtriaged workflowplanning breakdown labels
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/user/group/epics/linked_epics.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
Danger-
- Resolved by Marcin Sedlak-Jakubowski
@amandarueda Hi! I've added sections based on your stubs in #407465 (closed). Would you mind reviewing whether everything makes sense? Thanks!
requested review from @amandarueda
mentioned in issue technical-writing#1144
- Resolved by Amanda Rueda
- Resolved by Brendan Lynch
@brendan777 Hi! Would you mind reviewing and merging this? Thanks!
cc @sselhorn I'm adding 3 use case topics to this page, so I wanted to group them somehow, but still follow the Concept guidance to incorporate use cases as concept topics.
Brendan or Suzanne, feel free to modify that h2 however you like.
requested review from @brendan777
- Resolved by Brendan Lynch
- Resolved by Marcin Sedlak-Jakubowski
- Resolved by Marcin Sedlak-Jakubowski
- Resolved by Marcin Sedlak-Jakubowski
- Resolved by Marcin Sedlak-Jakubowski
requested review from @brendan777
mentioned in issue #510118
started a merge train
mentioned in commit 23aa420c
added workflowstaging-canary label and removed workflowin dev label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label