Simplify and co-locate the current Application limits documentation
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
As set out in Make Application Limits Accessible Through Abst... (gitlab-com/gl-infra&1032) , the documentation for application limits across GitLab is fragmented and hard to discover, meaning that engineering efficiency is reduced and DX is poor.
Further details
The app limits working group put together the Next Rate Limiting Architecture Blueprint which serves as a guide to how Application Limits should be architected across GitLab.
The Documentation is fractured and hard to discover and attempts to serve two unique personas right now:
- GitLab Administrator (User/Customer)
- GitLab team-member
The documentation needs to be located in a single place that is easy to discover and relevant to the persona that is discovering it.
Proposal
- Consolidate the current application limits documentation and move to an SSoT that links all of the resources on application limits at GitLab together
- Split/reproduce the documentation based on persona/use case
- GitLab Administrator or instance limits
- GitLab team member/Feature Engineer or configurable feature limits
- Send out comms on updated location and SSoT
Who can address the issue
Requires some knowledge on application limits and personas
Other links/references
Documentation Links with reference to limits:
- Feature Development
- Administration
- https://docs.gitlab.com/ee/administration/instance_limits.html
- https://docs.gitlab.com/ee/security/rate_limits.html
- https://docs.gitlab.com/ee/api/settings.html
- https://docs.gitlab.com/ee/user/admin_area/settings/user_and_ip_rate_limits.html
- https://docs.gitlab.com/ee/administration/pages/#rate-limits
- https://docs.gitlab.com/ee/user/admin_area/settings/account_and_limit_settings.html
- Usage Terms