documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Alternative take on the instance list rewrite

Open syeopite opened this issue 4 years ago • 10 comments

This is an alternative take on #74 that automates everything.

Preview: https://github.com/syeopite/documentation/blob/alt-instance-list/Invidious-Instances.md

The Instance list is now defined in instances.yaml. When a PR is made that edits that file, GH actions would run and automatically generate the markdown version of the list through a python script.

The data and design (markdown result) from this PR is mostly taken from #74 as well

syeopite avatar May 30 '21 00:05 syeopite

If you plan to add this I would love to have a box for ISP (some ISPs are better with privacy than others).

trentwiles avatar Jun 09 '21 14:06 trentwiles

If you plan to add this I would love to have a box for ISP (some ISPs are better with privacy than others).

What do you mean by "a box for ISP"?

unixfox avatar Jun 09 '21 15:06 unixfox

A box that shows the instance's host/Internet Service Provider. (ie. invidious.snopyta.org is on Hetzner)

trentwiles avatar Jun 09 '21 17:06 trentwiles

A box that shows the instance's host/Internet Service Provider. (ie. invidious.snopyta.org is on Hetzner)

Oh, you mean a column about the hosting provider in the table? We could do that, but the issue is that it would get outdated very quickly because the administrators of Invidious instances change the host from time.

But we could like update it automatically with a script.

unixfox avatar Jun 09 '21 17:06 unixfox

But we could like update it automatically with a script.

True, could you do something like this with GitHub actions.

trentwiles avatar Jun 09 '21 20:06 trentwiles

I'd suggest the following things:

  • make the country field a simple text string, containing the 2 letter ISO 3166 country code, and then provide the country name+flag from that (so people don't have to search for the proper unicode flag for their country).

  • replace modified: { is_modified: false, source: null } with simply modified: false, source: null (i.e remove the unnecessary nesting)

SamantazFox avatar Jun 19 '21 14:06 SamantazFox

Eventually, the owners attribute needs to support urls other than Github.

syeopite avatar Jun 29 '21 17:06 syeopite

Hmm. The design of the onion instance table needs to be changed, it really doesn't look great with the new notes column.

syeopite avatar Jul 16 '21 09:07 syeopite

Hmm. The design of the onion instance table needs to be changed, it really doesn't look great with the new notes column.

Why not going for a footnotes style?

Column A Column B Column C ... Notes
Text Text Text ... 1
Text Text Text ... 1,2

Notes:

  1. Lorem ipsum
  2. Hello, world

SamantazFox avatar Jul 25 '21 21:07 SamantazFox

The notes column is technically allowed to be anything. And as such, the footnotes has the possibility of getting bloated fast. There's no way to directly link to a footnote either, so accessing them becomes a problem once the list is large enough.

syeopite avatar Jul 28 '21 11:07 syeopite