-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BCDA-8124: Best practices for speeding up downloads #200
Conversation
<p> | ||
Requesting compressed data can help increase your download speed. You can request compressed data files by | ||
specifying the `Accept-Encoding: gzip` header in your download requests. After you finish downloading, uncompress | ||
(unzip) the file to access your data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to uncompress; by specifying the header, the user's request agent should uncompress the data due to the returned Content-Encoding header. This just speeds up transport
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -170,8 +170,8 @@ <h3 class="ds-c-alert__heading"> Files expire after 24 hours.</h3> | |||
</div> | |||
|
|||
<p> | |||
The "Accept-Encoding: gzip" header is optional, but will return a significantly smaller (40X smaller) file with a faster download speed. You will need to uncompress the file after downloading if you supply this header. When downloading multiple files, you can further speed up the process by downloading multiple files concurrently. | |||
The "Accept-Encoding: gzip" header is optional, but will return a significantly smaller (40X smaller) file with a faster download speed. Follow our recommended best practices for <a href="#speeding-up-downloads" class="in-text__link">speeding up downloads</a>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we decrease to ~30X? In tests, compression ratios are closer to 30x than 40.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎫 Ticket
https://jira.cms.gov/browse/BCDA-8124
🛠 Changes
ℹ️ Context for reviewers
Content drafted in BCDA-8000 and published to https://stage.bcda.cms.gov/build.html
✅ Acceptance Validation
Deployed to staging and verified links work
https://stage.bcda.cms.gov/build.html#speeding-up-downloads
https://stage.bcda.cms.gov/build.html#requesting-all-three
🔒 Security Implications
If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.