Uploading metric images to incidents - docs
What does this MR do?
Adds docs for a new feature - uploading metric images to incidents.
Related issues
Issue: #235994 (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.
-
Assign 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:
- [n/a] Update the permissions table.
- [n/a] 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). - [n/a] 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 %13.7
Assigning you as the technical writer @aqualls
added docsfeature label
@seanarnold could you please give this a review? Thanks!
assigned to @seanarnold
requested review from @seanarnold
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/operations/incident_management/img/incident_metrics_tab_v13_8.png
doc/operations/incident_management/img/metric_image_url_dialog_v13_8.png
doc/operations/incident_management/incidents.md
The review does not need to block merging this merge request. See the:
- Technical Writers assignments for the appropriate technical writer for this review.
- 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 🤖 GitLab Bot 🤖added Technical Writing twdoing labels
assigned to @aqualls
- Resolved by Amy Qualls
@tristan.read Pushed some boring changes. Dropped the pixel width and height on both images, and then ran both images through
pngquant
. The compression was fine on the old images, but the sizing was a bit big. (We try to keep the largest dimension under 1000 pixels.)Added in text edits, too.
That completes my work. Approving and unassigning myself; I don't need to see this work again before it's released.
unassigned @aqualls
added twfinished label and removed twdoing label
added sectionops label
Text here looks good @tristan.read! LGTM
unassigned @seanarnold
changed milestone to %13.8
added missed:13.7 label
mentioned in merge request !46731 (merged)
mentioned in merge request !51552 (merged)
mentioned in issue #293934 (closed)
mentioned in issue #235994 (closed)
mentioned in merge request gitlab-com/www-gitlab-com!65341 (merged)
added 3479 commits
-
efba1411...f45c60e5 - 3476 commits from branch
master
- c554d85f - Add docs for metric images
- 6912a1e2 - Revisions from technical writing team
- d47e4727 - Update references of 13.7 to 13.8
Toggle commit list-
efba1411...f45c60e5 - 3476 commits from branch
marked the checklist item 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. as completed
marked the checklist item Add twfinished if Technical Writing team work on the MR is complete but it remains open. as completed
marked the checklist item Add the corresponding
docs::
scoped label. as completedmarked the checklist item Ensure Technical Writing and documentation are added. as completed
assigned to @oregand
added 11 commits
-
d47e4727...35522f85 - 8 commits from branch
master
- a7948af7 - Add docs for metric images
- 96b0b191 - Revisions from technical writing team
- 1026a686 - Update references of 13.7 to 13.8
Toggle commit list-
d47e4727...35522f85 - 8 commits from branch
enabled an automatic merge when the pipeline for 8b17f8f1 succeeds
mentioned in commit 3597acf8
added workflowstaging label
added workflowcanary label and removed workflowstaging label
added workflowproduction label and removed workflowcanary label
added releasedcandidate label
added typemaintenance label