Add documentation to Files API Rate Limits
What does this MR do?
Contributes to #335075
Roadmap
- Database migration MR: !68559 (merged)
- Throttling configuration form in Admin Area MR: !68560 (merged)
- Rack attack configuration MR: !68561 (merged)
- Documentation update <== This MR
Why
We want to have an option to rate limit Files API requests.
Current MR
- Add documentation for Files API rate limit settings
Screenshots or Screencasts (strongly suggested)
How to setup and validate locally (strongly suggested)
-
Enable feature flag:
Feature.enable(:files_api_throttling)
-
Go to Admin Area -> Network: http://localhost:3000/admin/application_settings/network
-
Check that
Files API Rate Limits
section is appeared
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Merge request reports
Activity
changed milestone to %14.3
added documentation groupsource code typefeature labels
assigned to @vyaklushin
mentioned in merge request !68561 (merged)
mentioned in merge request !68560 (merged)
mentioned in merge request !68559 (merged)
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/administration/instance_limits.md
doc/api/repository_files.md
doc/security/rate_limits.md
doc/user/admin_area/settings/files_api_rate_limits.md
doc/user/admin_area/settings/index.md
doc/user/admin_area/settings/user_and_ip_rate_limits.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Dangeradded 4 commits
-
b22b7c4a...9e88aaf9 - 3 commits from branch
335075_rate_limiting_for_files_api
- 51d3cf8b - Add documentation to Files API Rate Limits
-
b22b7c4a...9e88aaf9 - 3 commits from branch
added 4 commits
-
964ecf30...2f2316eb - 3 commits from branch
335075_rate_limiting_for_files_api
- 934430b3 - Add documentation to Files API Rate Limits
-
964ecf30...2f2316eb - 3 commits from branch
added 4 commits
-
934430b3...a34efc12 - 3 commits from branch
335075_rate_limiting_for_files_api
- 89a647a7 - Add documentation to Files API Rate Limits
-
934430b3...a34efc12 - 3 commits from branch
Setting label(s) Category:Source Code Management devopscreate sectiondev based on groupsource code.
added Category:Source Code Management devopscreate sectiondev labels
added 2450 commits
-
89a647a7...15790615 - 2449 commits from branch
master
- 8f393fdb - Add documentation to Files API Rate Limits
-
89a647a7...15790615 - 2449 commits from branch
Hi @aqualls!
Can you please review documentation changes?requested review from @aqualls
added Technical Writing docsfeature tw-weight8 twdoing labels
added 607 commits
-
5cd04fc3...310d1982 - 605 commits from branch
master
- 61a522bc - Add documentation to Files API Rate Limits
- 9130fd19 - Technical writing revisions: tone and style
-
5cd04fc3...310d1982 - 605 commits from branch
- Resolved by Amy Qualls
mentioned in merge request !70310 (merged)
added 1011 commits
-
9130fd19...7da78439 - 1008 commits from branch
master
- 3da4af85 - Add documentation to Files API Rate Limits
- a014f3fb - Technical writing revisions: tone and style
- 96733577 - Revise the instructions now that I have access
Toggle commit list-
9130fd19...7da78439 - 1008 commits from branch
added 1 commit
- 79f99fb1 - Revise the instructions now that I have access
- Resolved by Amy Qualls
I have been the blocker on this MR, but now that I have access to the feature flag, I can see @vyaklushin's work in the UI. He and I are very very async because of timezones. I'd like to get this work merged, and then do a post-merge review on the docs changes. I'll use this thread to spin up an issue for that review.
(I'm also going on PTO in a few days, and changes in a post-merge review can be handled by anyone on the Technical Writing team -- not just me!)
mentioned in issue #341304 (closed)
- Resolved by Craig Norris
Sending over to @sming-gitlab for a quick review / merge. I've created #341304 (closed) for the post-merge review.
changed milestone to %14.4
added tw-weight13 twfinished labels and removed tw-weight8 twdoing labels
requested review from @sming-gitlab
@sming-gitlab
, thanks for approving this merge request.This is the first time the merge request is approved. To ensure full test coverage, a new pipeline has been started.
For more info, please refer to the following links:
mentioned in merge request gitlab-docs!2157 (merged)
removed review request for @aqualls
@aqualls - Looks good. I made a minor change in one section to change an "in" to an "on" to match our style guidelines for interacting with the sidebar menu. Approved and merged.
mentioned in commit f599cd82
added workflowstaging-canary label
added workflowstaging label and removed workflowstaging-canary label
added workflowcanary label and removed workflowstaging label
added workflowproduction label and removed workflowcanary label
added releasedcandidate label
mentioned in merge request kubitus-project/kubitus-installer!306 (merged)
added releasedpublished label and removed releasedcandidate label