Skip to content

Refactor the subscriptions documentation

Achilleas Pipinellis requested to merge axil-docs-refactor-subscriptions into master

What does this MR do?

The subscriptions page was a big wall of text hard to parse. There's been some internal discussions about how could one find their subscription, and by reading the docs, it wasn't apparent.

This MR:

  • Splits the GitLab.com and self-managed info into their own pages
  • Extracts the customers portal info in the index page
  • Adds new "Find your subscription" section

Navbar changes in gitlab-docs!1153 (merged)

Related issues

This work is mostly based because people have a hard time finding their current subscription gitlab-docs#853 (comment 410203507).

Author's checklist (required)

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:

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

  • 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.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

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.
Edited by Achilleas Pipinellis

Merge request reports