Skip to content

Move the architecture details to the docs site

Marcel Amirault requested to merge docs-move-architecture-page into master

What does this MR do?

I was about to create some docs to resolve gitlab-docs#1219 (closed) by explaining the CI/CD pipeline setup, when I realized that we do have some of this documented already at https://docs.gitlab.com/ee/development/documentation/site_architecture/#pipelines.

This reminded me of #344083, which points out that some documentation still needs to be moved into the gitlab-docs project.

In this MR, I'm Removing some of the architecture details that should be documented within the project itself. The MR that adds the content to the other project is: gitlab-docs!3009 (merged)

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 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