Skip to content

Add documentation for Self-Managed Code Suggestions

Matthias Käppler requested to merge 422369-cloud-connector-mvc-docs into master

What does this MR do?

Add documentation for Self-Managed Code Suggestions architecture and implementation. This was the Cloud Connector MVC project.

The audience for these docs is primarily GitLab Team members, as we frequently get the question how this works, and since there is substantial confusion about what Cloud Connector is technically, and what it isn't.

This MR replaces !129610 (closed) since it contains mostly backward looking documentation.

Preview: https://main-ee-131628.docs.gitlab-review.app/ee/development/cloud_connector/code_suggestions_for_sm.html

Related issues

#422369 (closed)

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.
Edited by Matthias Käppler

Merge request reports