Skip to content

Commit a6537a6

Browse files
acuteenvykbdharun
andauthored
CLIENT-SPECIFICATION: deprecate the old asset URL (#12452)
* CLIENT-SPECIFICATION: deprecate the old asset URL * chore: prepare for release Signed-off-by: K.B.Dharun Krishna <[email protected]> --------- Signed-off-by: K.B.Dharun Krishna <[email protected]> Co-authored-by: K.B.Dharun Krishna <[email protected]>
1 parent 1f8a492 commit a6537a6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

CLIENT-SPECIFICATION.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# tldr-pages client specification
22

3-
**Current Specification Version:** 2.1
3+
**Current Specification Version:** 2.2
44

55
This document contains the official specification for tldr-pages clients. It is _not_ a specification of the format of the pages themselves - only a specification of how a user should be able to interface with an official client. For a list of previous versions of the specification, see the [changelog section](#changelog) below.
66

@@ -216,6 +216,9 @@ Step | Path checked | Outcome
216216

217217
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>**.
218218

219+
> [!CAUTION]
220+
> 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.
221+
219222
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.
220223

221224
## Changelog
@@ -232,10 +235,11 @@ the form `vX.Y`) should be done immediately AFTER merging the version bump, as
232235
the commit hash changes when merging with squash or rebase.
233236
-->
234237

235-
- Unreleased
238+
- [v2.2, March 20th 2024](https://github.com/tldr-pages/tldr/blob/v2.2/CLIENT-SPECIFICATION.md) ([#12452](https://github.com/tldr-pages/tldr/pull/12452))
236239
- Removed redirect text from the [caching section](#caching) ([#12133](https://github.com/tldr-pages/tldr/pull/12133))
237240
- Updated asset URLs to use GitHub releases ([#12158](https://github.com/tldr-pages/tldr/pull/12158))
238241
- Add requirement to disambiguate triple-brace placeholders ([#12158](https://github.com/tldr-pages/tldr/pull/12158))
242+
- Add notice to deprecate the old asset URL ([#12452](https://github.com/tldr-pages/tldr/pull/12452))
239243

240244
- [v2.1, November 30th 2023](https://github.com/tldr-pages/tldr/blob/v2.1/CLIENT-SPECIFICATION.md) ([#11523](https://github.com/tldr-pages/tldr/pull/11523))
241245
- Add requirement to support escaping the placeholder syntax in certain pages ([#10730](https://github.com/tldr-pages/tldr/pull/10730))

0 commit comments

Comments
 (0)