documentation
documentation copied to clipboard
Alternative take on the instance list rewrite
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
If you plan to add this I would love to have a box for ISP (some ISPs are better with privacy than others).
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"?
A box that shows the instance's host/Internet Service Provider. (ie. invidious.snopyta.org is on Hetzner)
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.
But we could like update it automatically with a script.
True, could you do something like this with GitHub actions.
I'd suggest the following things:
-
make the
countryfield 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 simplymodified: false, source: null(i.e remove the unnecessary nesting)
Eventually, the owners attribute needs to support urls other than Github.
Hmm. The design of the onion instance table needs to be changed, it really doesn't look great with the new notes column.
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:
- Lorem ipsum
- Hello, world
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.