Skip to content

Removes and redirects design documents from first half of 2023

What does this MR do?

Adds design documents from first half of 2023 (gitlab-com/content-sites/handbook!7024 - merged) is a MR dependency for this MR We should only merge this once the dependency has been deployed!

We are currently migrating the Architecture design documents from the gitlab project to the public handbook.

gitlab-com/content-sites/handbook!7024 (merged) adds all design documents of the first half of 2023 to the handbook (leaves out one document that has open MRs. See table on the migration issue). Now this MR removes the original documents from the gitlab repository and instead adds redirects to the handbook.

Excerpt from design docs table. These documents are in this MR.

Design document folder Creation Date Migrated? Redirect?
clickhouse_ingestion_pipeline 2023-01-10 🚧
ci_builds_runner_fleet_metrics 2023-01-25 🚧
gitaly_plugins 2023-02-01 🚧
clickhouse_usage 2023-02-02 🚧
clickhouse_read_abstraction_layer 2023-02-23 🚧
model_experiments_and_registry 2023-03-04 🚧
gitlab_events_platform 2023-03-06 🚧
runner_admission_controller 2023-03-07 🚧
permissions 2023-03-10 🚧
gitlab_ci_events 2023-03-15 🚧
object_pools 2023-03-30 🚧
organization 2023-04-05 🚧
gitlab_ml_experiments 2023-04-13 🚧
repository_backups 2023-04-26 🚧
ci_pipeline_processing 2023-05-15 🚧
git_data_offloading 2023-05-19 🚧
gitaly_adaptive_concurrency_limit 2023-05-30 🚧
gitaly_transaction_management 2023-05-30 🚧 Migration MR until here

Technical Writing maintainer review

Once approved, please ask @phillipwells for the Technical Writing review, so we can merge this. Additionally, post this or a similar message to the #docs Slack channel for visibility and if someone else wants to jump in:

Hello everyone :wave: this is another removal and redirect MR for
the architecture design documents migration. [LINK TO MR]

Phillipp Wells can you or someone else from your team please review
and merge this? :bow: Thanks a lot in advance :slight_smile:

Migration issue: https://gitlab.com/gitlab-com/content-sites/handbook/-/issues/279

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

Merge request reports