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

Fetch individual translation archives for cache based on the environment variable configuration #419

Closed
kbdharun opened this issue Sep 15, 2023 · 2 comments · Fixed by #420
Assignees
Labels
good first issue hacktoberfest help wanted Open for new contributors to work on

Comments

@kbdharun
Copy link
Member

As specified in Client Specification 2.0

"If appropriate, it is RECOMMENDED that clients implement a cache of pages. If implemented, clients MUST download the entire archive either as a whole from https://tldr.sh/assets/tldr.zip (Which redirects to https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr.zip) or download language-specific translation archives in the format https://tldr.sh/assets/tldr-pages.{{language-code}}.zip (Which redirects to https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.{{language-code}}.zip), along with the archive for English from https://tldr.sh/assets/tldr-pages.zip (It redirects to https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.zip).

Caching SHOULD be done according to the user's language configuration (if any), to not waste unneeded space for unused languages. Additionally, clients MAY automatically update the cache regularly."

So, we need to update the client behaviour to work with fetching only the specified language's archive when fetching based on configuration, we can include English by default as a fallback.

@vivekjoshi556
Copy link
Contributor

I would like to work on this. Can you please assign it to me?

@kbdharun
Copy link
Member Author

kbdharun commented Oct 1, 2023

I would like to work on this. Can you please assign it to me?

Sure, feel free to refer to this comment tldr-pages/tldr-python-client#217 (comment) for additional details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue hacktoberfest help wanted Open for new contributors to work on
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants