Skip to content

Improvements to Geo rails console scripts

Ben Prescott_ requested to merge docs-bprescott/20230602-geo_failed_repos into master

What does this MR do?

A couple of improvements to these rails console instructions; stating they run on the secondary is useful.

I've simplified the language slightly - we refer to these as 'basic', but we're providing them because they're a powerful way to achieve something that's hard otherwise.

Also added a script for handling all failed projects, since this is a really common use case.

The failure details for repos gets truncated

last_repository_sync_failure: "Error syncing repository: Temporary repository can..."

I'm hoping the rescue will capture the full error.

Related issues

Written for a customer ticket. GitLab team members with Zendesk access can read more

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