Skip to content
GitLab
Next

Add rate limit docs

Merged Michael Kozono requested to merge mk/add-rate-limit-docs into master

What does this MR do?

Attempts to clarify rate limits, which are currently very confusing for users, admins, and even GitLab employees.

  • Adds a document for GitLab.com-specific rate limits
  • Adds a document for Admin Area > Network > User and IP rate limits
  • Reframes the existing Rack Attack document as "Rack Attack initializer"
  • Attempts to steer admins to the simpler throttles in Admin Area settings
  • Adds a centralized doc at doc/security/rate_limits.md that links to all of the above

Related issues

Resolves https://gitlab.com/gitlab-org/gitlab-ce/issues/41308

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

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.

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 and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Michael Kozono