Draft: Adding CI/CD troubleshooting for modifying components vs creating a new release
What does this MR do?
- This MR adds a troubleshooting subsection to advise CI/CD component authors that local modifications to the component need to be part of a release before those modifications will be reflected in pipelines that reference the component
- We're still in the incipient stage of CI/CD components being a feature, so customers (and team members!) are still learning about it
- It may be worth emphasising higher on the page that changes won't be reflected unless they are part of a release (we could probably mention it in the first pre-section, or in the testing section
Context:
-
A customer encountered an error, but applied a fix to the error inside their component
.yml
file - The customer expressed confusion that their local modifications to a component's
.yml
file was still resulting in the same error - It became clear that the pipeline referencing the component (and raising the error) was still referencing the original, erroneous version of the component
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.