Guide for adding a new service component to GitLab

What does this MR do?

Documents the process for having a new service component added to GitLab. So far this is essentially documenting the existing process, but because it spans several teams and was previously undocumented this is something a contributor ends up finding out while they are already in the process, and has been slightly different case-to-case. A maintainer wherever they start the process will typically point them in the direction of the next step. This MR helps show the process up-front.

This is non-exhaustive, but is hopefully a good starting point that we can continue to expand on.

I have a followup issue gitlab-com/www-gitlab-com#8537 (closed) where I intend to create an issue template for adding a new service, that checklists the process and links back to this doc.

Related issues

Related to gitlab-com/Product#559 (closed) Related to gitlab-com/www-gitlab-com#8535 (closed)

Author's checklist (required)

• Follow the Documentation Guidelines and Style Guide.
• If you have developer access or higher (for example, GitLab team members or Core Team members)
  • Apply the documentation label, plus:
    • The corresponding DevOps stage and group label, if applicable.
    • development guidelines when changing docs under doc/development/*, CONTRIBUTING.md, or README.md.
    • development guidelines and Documentation guidelines when changing docs under development/documentation/*.
    • development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
  • Assign the designated Technical Writer.

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

• Update the permissions table.
• Link docs to and from the higher-level index page, plus other related docs where helpful.
• Add GitLab's version history note(s).
• Add the product tier badge.
• Add/update the feature flag section.
• If you're changing document headings, search doc/*, app/views/*, and ee/app/views/* for old headings replacing with the new ones to avoid broken anchors.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

• Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

• Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
  • Add Technical Writing and docs:: workflow label.
  • Add docs-only when the only files changed are under doc/*.

3. Maintainer

1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
2. Ensure a release milestone is set.
3. If there has not been a technical writer review, create an issue for one using the Doc Review template.