Updated title to be more descriptive
-
Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.
What does this MR do?
The tutorial title 'Set up steps' is a little generic without context that this is for CI/CD. This updates the title to make it less generic and more descriptive.
Related issues
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
assigned to @fneill
added sectionci label
26 Warnings This MR has a Changelog commit for EE, but no code changes in ee/
. Consider removing theEE: true
trailer from your commits.d2322085: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 51b42d66: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. de2785f2: The commit subject may not be longer than 72 characters. For more information, take a look at our Commit message guidelines. f31d314d: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. d37159ab: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. de48ec05: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 617be644: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. c56ebf2a: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. b9b71d7e: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 87277c28: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. c10ee4b6: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. ea11fbab: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 0cc393ba: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 677aedf8: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 5e09abc8: The commit subject may not be longer than 72 characters. For more information, take a look at our Commit message guidelines. 5e09abc8: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. a1fbd59e: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. af7b4404: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 009f661f: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 8167c5a6: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. cbf9f48e: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 6cbe282b: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. a6639673: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 7c56b7b7: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. This merge request has more than 20 commits which may cause issues in some of the jobs. If you see errors like missing commits, please consider squashing some commits so it is within 20 commits. 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/tutorials/setup_steps/index.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-
added docs-only label
added 3649 commits
-
e6ebaf19...407d5bcb - 3648 commits from branch
master
- 61f69aa7 - Merge branch 'master' into 'fneill-master-patch-85465'
-
e6ebaf19...407d5bcb - 3648 commits from branch
- Resolved by Fiona Neill
Hey @marcel.amirault
I thought this tutorial should have an update to make it more descriptive. If you approve, can you set to merge? Thanks!requested review from @marcel.amirault
changed milestone to %17.1
Hi
@marcel.amirault
,GitLab Bot has added the Technical Writing label because a Technical Writer has approved or merged this MR.
This message was generated automatically. You're welcome to improve it.
added Technical Writing label
@fneill Yup, makes sense, LGTM!
enabled automatic add to merge train when the pipeline for e660a217 succeeds
mentioned in commit 87296ba5
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label