Skip to content

Removes and redirects design docs second half of 2023

What does this MR do?

Adds design documents from second half of 2023 (gitlab-com/content-sites/handbook!7028 - 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!7028 (merged) adds all design documents of the second half of 2023 to the handbook (leaves out documents that have open MRs and already migrated documents. 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?
container_registry_metadata_database_self_managed_rollout 2023-06-09 👷
gitaly_handle_upload_pack_in_http2_server 2023-06-15 👷
observability_tracing 2023-06-20 👷
ai_gateway 2023-07-14 👷
ssh_certificates 2023-07-28 👷
runway 2023-07-31 👷
bundle_uri 2023-08-04 👷
secret_manager 2023-08-07 👷
gitlab_services 2023-08-18 👷
google_artifact_registry_integration 2023-08-31 👷
transfer_data 2023-09-07 👷
observability_for_self_managed 2023-09-11 👷
activity_pub 2023-09-12 👷
rapid_diffs 2023-10-10 👷
cdot_orders 2023-10-12 👷
google_cloud_platform_integration 2023-10-26 👷
observability_logging 2023-10-29 👷
feature_flags_usage_in_dev_and_ops 2023-11-01 👷
pipeline_execution_policy 2023-11-23 👷
ci_gcp_secrets_manager 2023-11-29 👷
security_policies_database_read_model 2023-12-07 👷
tailwindcss 2023-12-21 👷 Migration MR until here gitlab-com/content-sites/handbook!7028 (merged)

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

gitlab-com/content-sites/handbook#279 (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 Marc Saleiko

Merge request reports

Loading