Skip to content

Refactor Gitaly GDK docs

Evan Read requested to merge eread/refactor-gitaly-gdk-docs into master

What does this Merge Request do?

While experimenting using GDK for gitlab#293856, I realized the documentation could be broken up into more discrete components. At the moment, adding a virtual storage seems like a compulsory step to adding a Gitaly node, which isn't the case.

The documentation here should be limited to GDK-specific things. GDK users should still refer to the main product documentation to figure out what they need (for example, what is required for a Gitaly Cluster). This is just the "how in GDK".

CC @mjwood @zj-gitlab @samihiltunen

Merge Request checklist

  • Tests added for new functionality. If not, please raise Issue to follow-up.
  • This change is backward compatible. If not, please include steps to communicate to our users.
  • Documentation added/updated, if needed.
  • gdk doctor test added, if needed.

Merge request reports