Skip to content

Allow deprecations doc pipeline check to fail

Marcel Amirault requested to merge deprecation-doc-pipeline-allow-fail into master

What does this MR do?

The process of implementing gitlab-com/Product#2864 (closed) isn't starting off as smoothly as I hoped... 💦

The rake task (added in !66770 (merged)) and CI job (added in !69358 (merged)) is working properly, but everyone is trying to make use of the process at the same time. With a rush of people trying to merge their deprecations all at the same time, they are all conflicting with each other. Considering the small initial size of the doc, it means every merge is causing everyone else's MR to conflict, repeatedly.

These conflicts should slowly be reduced over time, as the initial rush of MRs dies down, and the file size increases.

Let's set the job to allow_failure: true for now, and the Product team can all merge their initial YAML files without rebuilding the doc. I, or someone else on the TW team, can then generate the doc and merge the changes in a separate MR.

When the initial rush is reduced, I'll set it back to allow_failure: false, and hopefully it'll work more like the locale.pot file, which is autogenerated, but doesn't suffer (as much) from repeated conflicts.

Related issues

Related to gitlab-com/Product#2864 (closed)

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports