Explain basics of how a CI job clones the repo
What does this MR do?
This is an attempt to close a gap in our documentation. Two months ago I asked on Slack:
Hi team, I’m wondering: Do we anywhere explicitly say that the repo checkout at the beginning of a CI job is performed via HTTPS? We have a bunch of stuff on how to tune the process (1, 2) and then this kinda proves it… but I can’t find a sentence that just says “The initial repo checkout is performed using HTTPS and authenticated with the CI_JOB_TOKEN”. Did I overlook something? I think it’d be nice to have it spelled out somewhere.
And indeed we don't seem to spell this out anywhere currently. This initial change doesn't quite address it – because the "Getting Started" page isn't quite the right place for the level of detail with "HTTPS" and "CI_JOB_TOKEN", I believe. I couldn't think of a better place right away, so I'm creating this as a first iteration.
I think this tiny change alone would also be good, but I still hope we can find a good place for the thing I'd actually want to mention in the docs more clearly.
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.