Client specification v2.2: New cache asset URLs, 10 years of TLDR pages

[kbdharun]

Calling all maintainers of both clients and tldr alike!

Since the previous v2.1 release, a lot of work has been going on behind the scenes to improve tldr and how we publish and distribute assets.

Important

With this release, we are introducing a newer version of client specification with a major change to the asset URLs to use GitHub releases (to replace the existing method of providing assets via the https://tldr.sh domain).

Changelog 📜

• Removed redirect text from the caching section (#12133) (thanks @sbrl)
• Updated asset URLs to use GitHub releases (#12158) (thanks @acuteenvy)
• Add requirement to disambiguate triple-brace placeholders (#12158) (thanks @acuteenvy)
• Add notice to deprecate the old asset URLs (#12452) (thanks @acuteenvy)

Change in Asset URLs

Previously, we distributed assets via GitHub pages hosted in a combined Git repository for both the website and the assets artifacts. Which introduced multiple issues with maintenance and size constraints, after multiple discussions like #12048, we concluded that GitHub releases are the ideal candidate to publish the ZIP, PDF and checksum assets in a rewriteable way.

This client specification release requires all clients to update their cache URLs to the new GitHub release URLs. The updated caching section is attached below for reference:

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://github.com/tldr-pages/tldr/releases/latest/download/tldr.zip or download language-specific archives in the format https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.{{language-code}}.zip (e.g. https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.en.zip). The English archive is also available from https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.zip.

Caution

Prior to version 2.2, the client specification stated that clients MUST download archives from https://tldr.sh/assets. This method is now deprecated, and will be removed in the future.

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.

---

10 years of TLDR pages 🎉

We're thrilled to announce that the TLDR pages project celebrated its tenth anniversary this past December, marking a decade since @rprieto's initial commit. What began with a focus on osx (macOS) has blossomed over the years into a comprehensive resource spanning multiple platforms, with thousands of pages added.

With its expanding reach across the FOSS scene, TLDR Pages owes its success to the countless contributors and maintainers who have dedicated their time and expertise to the project. Thank you for your invaluable contributions. Here's to another ten years of making knowledge accessible and empowering command-line users globally!

---

This discussion was created from the release Client specification v2.2: New cache asset URLs, 10 years of TLDR pages.