Skip to content

Re-organizing subscrip page

Suzanne Selhorn requested to merge selhorn-subscription-redo into master

What does this MR do?

We are looking to potentially redesign the docs site a bit, and as part of this work, we're standardizing the "top-level pages" to be lists of links. See this proof of concept for an example: https://sarahg-topnav.docs.gitlab-review.app/ee/user/

As part of that, I'd like to re-organize the Subscription area a bit. Here is what it will look like when this MR and the related navigation MR merge:

image

I took all of the content on the current top-level page and split it into three other pages:

  • Choose a subscription
  • Customers Portal
  • Community programs

The top-level page is now just links to the pages in the left nav. NOTE: I did not change any text, just moved it around and fixed affected links.

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

Merge request reports