Skip to content

Explain how/why to disable background jobs better

Manuel Grabowski requested to merge mg-backgroundmaintenance-20230711 into master

What does this MR do?

Following a Slack discussion on delayed project deletion being performed while Maintenance Mode is enabled I wanted to clarify:

  • Why one might want to disable background jobs in maintenance mode
  • How to actualy do it

On Slack, I wrote:

I wonder if we should try and list a few common things that happen via cron jobs in that section, so that someone going over that docs page can more easily understand if and why they might want to disable background jobs. As a counter example: Pull mirrors don’t automatically update in maintenance mode. Even as an admin I get an error when trying to force it manually.

I've decided to not add specific examples for now, as I feel that would send too strong a signal that these are the only relevant things. I don't know well enough what all the things that still happen during Maintenance Mode via background jobs are. In my testing I quickly found a counter example as Pull Mirror updates are not happening.

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.

Merge request reports