Skip to content

[Support] Remove obsolete Epub, PDF and HTMLZip downloads from Godot docs #8135

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

Closed
akien-mga opened this issue Apr 24, 2021 · 7 comments
Closed
Labels
Support Support question

Comments

@akien-mga
Copy link
Contributor

Details

Support request

I'd like to request the existing, obsolete Epub, PDF and HTMLZip downloads for the Godot documentation to be removed: https://readthedocs.org/projects/godot/downloads/ (I'm the project admin).

Godot documentation is huge and neither of those options are usable. We recently re-tried Epub downloads and they were broken: godotengine/godot-docs#3862.

Current Godot stable release is 3.3 so these old 2.1, 3.0 and 3.1 attempts at providing offline builds are now more harmful than useful.

We'd really love to provide multi-page HTML zips for offline use (#3242) but that's another issue :)

Thanks in advance!

@stsewd
Copy link
Member

stsewd commented Apr 26, 2021

Done https://readthedocs.org/projects/godot/downloads/! If you still can access old downloads it's probably a cached version.

@stsewd stsewd closed this as completed Apr 26, 2021
@stsewd stsewd added the Support Support question label Apr 26, 2021
@akien-mga
Copy link
Contributor Author

Thanks!

@akien-mga
Copy link
Contributor Author

If you still can access old downloads it's probably a cached version.

Is the cache expected to expire eventually? It's been 10 days and the downloads are still all up on https://readthedocs.org/projects/godot/downloads/

Screenshot_20210506_151223

@stsewd
Copy link
Member

stsewd commented May 6, 2021

@akien-mga last time I checked they weren't there. Looks like you triggered new builds for those versions https://readthedocs.org/projects/godot/builds/, that would regenerate the epub and pdf files.

@stsewd
Copy link
Member

stsewd commented May 6, 2021

If you are able to change old versions, you can set the formats to an empty list using the config file https://github.com/godotengine/godot-docs/blob/3.1/.readthedocs.yml (v2 is recommended https://docs.readthedocs.io/en/stable/config-file/v2.html

@akien-mga
Copy link
Contributor Author

Oh you're right! Sorry about that.

Rebuilding each branch with all formats disabled did the trick, and even removed the existing downloads: https://readthedocs.org/projects/godot/downloads/

So it seems I didn't even need to ask for admin intervention to remove them, but just changing the config also removes old builds? If so, maybe I can contribute a paragraph about it in https://docs.readthedocs.io/en/stable/downloadable-documentation.html?

@stsewd
Copy link
Member

stsewd commented May 6, 2021

So it seems I didn't even need to ask for admin intervention to remove them, but just changing the config also removes old builds? If so, maybe I can contribute a paragraph about it in https://docs.readthedocs.io/en/stable/downloadable-documentation.html?

Sure, anything that should have done this more explicit. Maybe a "Deleting downloadable content" section

akien-mga added a commit to akien-mga/readthedocs.org that referenced this issue May 6, 2021
akien-mga added a commit to akien-mga/readthedocs.org that referenced this issue May 6, 2021
akien-mga added a commit to akien-mga/readthedocs.org that referenced this issue Jun 2, 2021
stsewd pushed a commit that referenced this issue Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Support Support question
Projects
None yet
Development

No branches or pull requests

2 participants