Draft: Clarity for OpenID first timers
Direct links to review app pages
- https://main-ee-116813.docs.gitlab-review.app/ee/ci/cloud_services/
- https://main-ee-116813.docs.gitlab-review.app/ee/ci/cloud_services/aws/
What does this MR do?
Adds clarity for those whose very first OpenID / OIDC / JWT token experience is with GitLab CI to a cloud account.
Mainly:
- Clearly separate once-per-cloud-account-federation activities from once-per-job/once-per-pipeline activities
- In jobs, add in actual "work commands" (in this case
aws s3 ls
) to show that they are just executed "plainly" after the token is setup. - add best practice full job yaml examples - one for "single job AWS access" and one for "most compact cloud orchestration pipeline"
- Show a simplified pattern for when the entire pipeline is doing cloud orchestration
- On main cloud page, put in actual use cases and label existing section as "features"
Related issues
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.
Edited by DarwinJS