Boto3 Docs Website Crashes on large Documentation pages

[ubaniabalogun]

trafficstars

Describe the bug Reporting this as a bug because I've experienced it on two different machines and browsers now and its significantly impacting my ability to use the docs.

The Boto3 documentation website hangs and eventually crashes in Chrome and Safari when I attempt to load pages. Pages that are particularly impacted by this include:

• S3 Reference page
• DynamoDB Reference page

Device tested on include

• 16GB MacBook Pro Apple M1 Pro 2021

Steps to reproduce

• Navigate to S3 Reference page
• Click Bucket link
• Watch as browser hangs and crashes

Expected behavior The documentation page should not crash when attempting to follow links. This makes the documentation unusable

Debug logs Here is a performance profile of Boto3 Docs page captured using Chrome Dev Tools. You can upload this performance profile to Chrome Dev tools to inspect page performance

[kdaily]

Hi @ubaniabalogun,

Thanks for the report. I understand the frustration in the documentation not loading. We're aware of issues on large pages like this. The documentation renders the page based on the service's API model, which in the case of services like S3, EC2, and DynamoDB, are extremely large. For example, the raw JSON describing the S3 API is 800KB.

We are considering using a different design to break up the documentation into smaller pieces and provide navigation within and between services. I don't have a timeframe as to when we would make these changes.

For anyone else seeing this, please 👍🏻 the initial comment to let us know that it affects you as well!

[orf]

A small incremental step towards this would be to enable gzip support on the cloudfront distribution.

[tim-finnigan]

Linking related issue: https://github.com/boto/boto3/issues/3067. One suggestion there was to split the client and resource documentation in order to improve load time.

[orf]

I think the first obvious thing to do is to enable compression? The docs are huge, yes, but reducing the amount of data transfer with gzip should be a no-brainer.

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html Unless I’m missing something?

[tim-finnigan]

Linking another related issue mentioning QuickSight documentation: https://github.com/boto/boto3/issues/3600

[tim-finnigan]

As https://github.com/boto/boto3/pull/3597 has been merged, the boto3 docs are now nested and the pages should load much faster.

Service documentation pages such as S3 now have links to individual methods, rather than loading every method's docs on the same page:

(If you're still seeing the old display then you may just need to clear your cache.)