Skip to content

Improve self-managed subscription docs

What does this MR do?

Improves the self-managed subscription documentation by addressing issues identified in !44378 (closed).

The changes are as follows:

  • Move the Customers Portal section to early in the document. This is a critical piece in subscription management, so it's important to introduce it early. As customers of resellers don't have access to the CP, it's also important to make them aware early in the document.
  • Edit the description of several subscription terminology, per Donique's feedback.
  • Clarify that you add seats to a subscription, not users.
  • Clarify the meaning of users over license and add an example.

Related issues

This MR replaces !44378 (closed). Significant changes had been made to the docs content while that MR was in progress. I opted to create a new MR rather than rebase the original MR.

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.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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 Russell Dickenson

Merge request reports

Loading