Skip to content
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

Reduce the size of the docs site files #326

Open
jessestorbeck opened this issue Apr 4, 2024 · 0 comments
Open

Reduce the size of the docs site files #326

jessestorbeck opened this issue Apr 4, 2024 · 0 comments
Labels
docs documentation

Comments

@jessestorbeck
Copy link
Contributor

I noticed this warning when deploying an update to the docs:

Screenshot 2024-04-04 at 11 18 03 AM

Looking at the docs files in the gh-pages branch, most of the artifact size is coming from the assets for version 3.6, which had a lot of duplicates of large gifs (these came from the previous Gitbook docs). This bloat was significantly decreased for v4.0, but 3.6's files remain unchanged in gh-pages (this is just how mike works; previous versions are unaffected when you deploy a new version).

When we eventually try to deploy docs v4.1, I worry the deployment will fail, since I'm guessing we'll be about 250 MB over the 1 GB limit. We may need to either (a) remove v3.6 or (b) manually remove some of the duplicate gifs that aren't being used in v3.6. I'd support the former, since it will be laborious to look through which image versions are actually used in the old docs (e.g. in some cases, if you see ubuntu7.gif and ubuntu7 (1).gif, it's actually the latter that's being referenced). We could also just wait and see if the next deploy fails before doing anything.

This is probably also an argument against overusing the screencap gifs in the future, since they are fairly large. We might also want to compress our site images for future docs versions.

@jessestorbeck jessestorbeck added the docs documentation label Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation
Projects
None yet
Development

No branches or pull requests

1 participant