Add first steps of an advanced pipeline tutorial
What does this MR do?
This MR adds a tutorial that users can follow to learn about specific keywords in a real-world pipeline example. Every step along the way introduces 2'ish new concepts or keywords, showing how to make use of them to improve the pipeline. Each step results in a larger, but still fully functional pipeline. If you stop at any point, you'll still have fully accomplished something, and you can pick up again later to continue expanding the pipeline.
There are more ideas for further tutorial steps in the linked issue, but the steps in this MR seemed like the best ones to start with.
- Review app: https://main-ee-118664.docs.gitlab-review.app/ee/ci/quick_start/tutorial.html
- Sample tutorial project: https://gitlab.com/gitlab-org/technical-writing-group/marcel-pipeline-tutorial-test
- Sample tutorial deployment: https://gitlab-org.gitlab.io/technical-writing-group/marcel-pipeline-tutorial-test/
Related issues
Resolves #389812 (closed)
Followup issues
- Should I link to a nice sample project?
- Should I link to a sample pipeline for each step? For example:
- Pipeline for step 4: https://gitlab.com/gitlab-org/technical-writing-group/marcel-pipeline-tutorial-test/-/pipelines/832760914
- Pipeline for step 5: https://gitlab.com/gitlab-org/technical-writing-group/marcel-pipeline-tutorial-test/-/pipelines/832784553
- Pipelines for final step:
Both ideas might promote too much clicking away from the tutorial, though. To address in a followup.
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 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.