Skip to content

Copy edit top half of Jenkins migration doc

Marcel Amirault requested to merge docs-jenkins-updates-1 into master

What does this MR do?

This is a copy edit of the top half of the Jenkins migration doc. I've attempted to simplify the language that already exists there, but have lowered the visibility of some details by moving them to the end of the page, and removed out of date or deprecated content.

A bigger change is that I'm trying to make this part of the doc more focused on GitLab, when possible, as it's hard to make statements about Jenkins (which is not our product). So saying that a Jenkinsfile can be complex and hard to read, that's a judgement about Jenkins that not everyone might share. It's better to say that GitLab uses YAML, which is different than the Groovy that Jenkins uses.

Related issues

Author's checklist

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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 Marcel Amirault

Merge request reports