!zXiOpjSkFTvtMpsenJ:gitter.im

tldr-pages/tldr

375 Members
📚 Collaborative cheatsheets for console commands. Repository: https://github.com/tldr-pages/tldr Website: https://tldr.sh Offtopic room: https://matrix.to/#/#tldr-pages_off-topic:gitter.im Space: https://matrix.to/#/#tldr-pages-project:matrix.org14 Servers

Load older messages


SenderMessageTime
23 Feb 2024
@managor:matrix.orgManagorAlways nice to tinker with some obscure commands and come out of it with several page edits.11:21:00
25 Feb 2024
@managor:matrix.orgManagorWhat was the default manual website that we use? manned?14:36:55
@managor:matrix.orgManagorI wasn't able to find a mention of it on CONTRIBUTING.md14:37:12
@managor:matrix.orgManagorOh it's in style-guide.md14:37:57
@sbrl-57247531659847a7aff542b6:gitter.imsbrl (Starbeamrainbowlabs)
In reply to @managor:matrix.org
What was the default manual website that we use? manned?
that's correct :-)
20:03:41
@sbrl-57247531659847a7aff542b6:gitter.imsbrl (Starbeamrainbowlabs)official website > manned tho20:03:57
@managor:matrix.orgManagorSadly the official website provided close to no documentation20:04:30
@sethi:one.ems.hostSeth

A bit of a show and tell, but just sharing progress on the tldr specification compliance repo I was working on. If we're happy with the idea, when I've cleaned it up I'd like to transfer it to the tldr-pages org.

https://github.com/SethFalco/tldr-pages-test-harness

The compliance badge looks ugly. At some point, I'll hit up a designer for that, but they're busy with college atm. I just rushed something up. ^-^'

Motivation was following some discussions that it'd be nice to have an objective measure of how well clients adhere to the tldr-pages specifications. This defines three levels, level 1 (required), level 2 (optional), level 3 (recommended).

23:51:03
@sethi:one.ems.hostSeth *

A bit of a show and tell, but just sharing progress on the tldr specification compliance repo I was working on. If we're happy with the idea, when I've cleaned it up I'd like to transfer it to the tldr-pages org.

https://github.com/SethFalco/tldr-pages-test-harness

The compliance badge looks ugly. At some point, I'll hit up a designer for that, but they're busy with college atm. I just rushed something up. ^-^'

Motivation was following some discussions that it'd be nice to have an objective measure of how well clients adhere to the tldr-pages specifications. This defines three levels, level 1 (required), level 2 (optional), level 3 (recommended).

TL;DR:

  • Defines a test suite using Bats to check compliance.
  • Contains a Dockerfile for each client (currently just tealdeer and tldr-node-client)
  • In GitHub actions, runs the tests for each client
  • Hosts a GitHub Pages site where each client has an image with their compliance status (currently just pass/fail)
23:52:16
@sethi:one.ems.hostSeth *

A bit of a show and tell, but just sharing progress on the tldr specification compliance repo I was working on. If we're happy with the idea, when I've cleaned it up I'd like to transfer it to the tldr-pages org.

https://github.com/SethFalco/tldr-pages-test-harness

The compliance badge looks ugly. At some point, I'll hit up a designer for that, but they're busy with college atm. I just rushed something up. ^-^'

Motivation is that following discussions on GitHub, some of us thought it'd be useful to have an objective measure of how well clients adhere to the tldr-pages specifications. This defines three levels, level 1 (required), level 2 (optional), level 3 (recommended).

TL;DR:

  • Defines a test suite using Bats to check compliance.
  • Contains a Dockerfile for each client (currently just tealdeer and tldr-node-client)
  • In GitHub actions, runs the tests for each client
  • Hosts a GitHub Pages site where each client has an image with their compliance status (currently just pass/fail)
23:53:19
@sethi:one.ems.hostSeth *

A bit of a show and tell, but just sharing progress on the tldr specification compliance repo I was working on. If we're happy with the idea, when I've cleaned it up I'd like to transfer it to the tldr-pages org.

https://github.com/SethFalco/tldr-pages-test-harness

The compliance badge looks ugly. At some point, I'll hit up a designer for that, but they're busy with college atm. I just rushed something up. ^-^'

Motivation is that following discussions on GitHub, some of us thought it'd be useful to have an objective measure of how well clients adhere to the tldr-pages specifications. This defines three levels, level 1 (required), level 2 (optional), level 3 (recommended).

TL;DR:

  • Defines a test suite using Bats to check compliance.
  • Contains a Dockerfile for each client (currently just tealdeer and tldr-node-client)
  • In GitHub actions, runs the tests for each client
  • Hosts a GitHub Pages site where each client has an image with their compliance status (currently just pass/fail)

Edit: Any feedback is welcome btw!

23:54:23
26 Feb 2024
@kbdk:matrix.orgK.B.Dharun KrishnaKinda curious, what makes the node client fail? Or is it a placeholder in README?00:00:50
@sethi:one.ems.hostSeth
not ok 2 REQUIRED: show tldr-page for TLDR (must be treated as lowercase)
…
not ok 14 REQUIRED: if LANG and LANGUAGE envvars are set to a supported language, output must use that language
00:01:55
@sethi:one.ems.hostSeth *
not ok 2 REQUIRED: show tldr-page for TLDR (must be treated as lowercase)
…
not ok 14 REQUIRED: if LANG and LANGUAGE envvars are set to a supported language, output must use that language

— https://github.com/SethFalco/tldr-pages-test-harness/actions/runs/8041540618/job/21960925714#step:3:351

00:02:18
@sethi:one.ems.hostSethIt fails some of the optional/recommended requirements too, but for now I set CI to only check the required stuff. Talking to the designer now to help me make nice badges that can show the various compliance levels somehow.00:03:06
@sethi:one.ems.hostSethtealdeer is the only client I've noticed that passed all required, optional, and recommended specifications.00:03:32
@kbdk:matrix.orgK.B.Dharun Krishna
In reply to @sethi:one.ems.host
not ok 2 REQUIRED: show tldr-page for TLDR (must be treated as lowercase)
…
not ok 14 REQUIRED: if LANG and LANGUAGE envvars are set to a supported language, output must use that language

— https://github.com/SethFalco/tldr-pages-test-harness/actions/runs/8041540618/job/21960925714#step:3:351

2 sound doable for me, regarding 14 it is already supported by the Node client is it failing because it is not detecting locale as en_US and just en?
00:05:00
@sethi:one.ems.hostSeth
In reply to @kbdk:matrix.org
2 sound doable for me, regarding 14 it is already supported by the Node client is it failing because it is not detecting locale as en_US and just en?

In the test case and locally, I used:

  export LANG="nl.UTF-8"
  export LANGUAGE="nl"

Could you try that?

00:06:10
@sethi:one.ems.hostSeth
In reply to @kbdk:matrix.org
2 sound doable for me, regarding 14 it is already supported by the Node client is it failing because it is not detecting locale as en_US and just en?
*

In the test case and locally, I used the following to test it:

  export LANG="nl.UTF-8"
  export LANGUAGE="nl"

Could you try that?

00:06:25
@sethi:one.ems.hostSeth
In reply to @kbdk:matrix.org
2 sound doable for me, regarding 14 it is already supported by the Node client is it failing because it is not detecting locale as en_US and just en?
*

In the test case and locally, I used the following to test it:

export LANG="nl.UTF-8"
export LANGUAGE="nl"

Could you try that?

00:06:39
@kbdk:matrix.orgK.B.Dharun KrishnaSure00:06:57
@acuteenvy:matrix.orgacuteenvy In #14 the script should run tldr --update before checking the output - the test will fail for clients that only cache configured languages, because nl wasn't previously configured. 00:11:03
@kbdk:matrix.orgK.B.Dharun KrishnaInteresting, I don't think nl has a translation for tldr page.00:11:22
@acuteenvy:matrix.orgacuteenvy The script checks 7z, not tldr. 00:12:11
@sethi:one.ems.hostSeth
In reply to @acuteenvy:matrix.org
In #14 the script should run tldr --update before checking the output - the test will fail for clients that only cache configured languages, because nl wasn't previously configured.
Ahh, I never considered that! I'll review this now.
Smhsmh, tfw no one tests the tests.
00:12:36
@kbdk:matrix.orgK.B.Dharun Krishna
In reply to @sethi:one.ems.host
In the test case and locally, I used the following to test it: ```sh export LANG="nl.UTF-8" export LANGUAGE="nl" ``` Could you try that?
Tested 7z, it works here post update as acutenvy says that might be the cause for the failing check (as some clients fetch language specific archives).
00:15:28
@sethi:one.ems.hostSeth
In reply to @kbdk:matrix.org
Tested 7z, it works here post update as acutenvy says that might be the cause for the failing check (as some clients fetch language specific archives).
Thanks for checking for me!
Indeed, I'll update the test to reflect this then.
00:20:56
@sbrl-57247531659847a7aff542b6:gitter.imsbrl (Starbeamrainbowlabs)
In reply to @sethi:one.ems.host
tealdeer is the only client I've noticed that passed all required, optional, and recommended specifications.
Ah yes
that is probably because the maintainers behind tealdeer have a focus on spec compliance
they have even pointed out ambiguous things in the spec before now too
00:51:30
@sbrl-57247531659847a7aff542b6:gitter.imsbrl (Starbeamrainbowlabs) looks like a cool project though Seth! 00:52:26
@acuteenvy:matrix.orgacuteenvy

I tested all other official clients:

  • the Python client fails one test - it doesn't support macos as an alias for osx,
  • the C client fails all language tests (because it doesn't support translations) + it doesn't convert uppercase letters to lowercase,
  • the Rust client passes.
01:30:02

There are no newer messages yet.


Back to Room ListRoom Version: 6