Skip to content

Document the actual behavior of remote push mirroring

Sami Hiltunen requested to merge smh-update-remote-mirror-behavior into master

What does this MR do?

The documentation of remote push mirroring doesn't reflect the actual behavior of the feature. The documentation describes that by default the mirroring would fail if there are any diverged refs in the mirror. This doesn't match reality and the mirroring functionality by default force pushes over the refs in the mirror. The keep divergent refs option then actually avoids force pushing over the diverged refs but has no effect on non-diverged refs.

Related issues

Closes gitaly#3509 (closed)

Author's checklist

To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database

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.
Edited by Sami Hiltunen

Merge request reports