Skip to content

Alternative take on the instance list rewrite - #76

Closed
syeopite wants to merge 23 commits into
iv-org:masterfrom
syeopite:alt-instance-list
Closed

Alternative take on the instance list rewrite#76
syeopite wants to merge 23 commits into
iv-org:masterfrom
syeopite:alt-instance-list

Conversation

@syeopite

@syeopite syeopite commented May 30, 2021

Copy link
Copy Markdown
Member

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
syeopite force-pushed the alt-instance-list branch from 4bbec92 to e4248a2 Compare May 30, 2021 00:55
Comment thread instances.yaml Outdated
Comment thread instances.yaml Outdated
@trentwiles

Copy link
Copy Markdown
Contributor

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

@unixfox

unixfox commented Jun 9, 2021

Copy link
Copy Markdown
Member

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"?

@trentwiles

Copy link
Copy Markdown
Contributor

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

@unixfox

unixfox commented Jun 9, 2021

Copy link
Copy Markdown
Member

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.

@trentwiles

Copy link
Copy Markdown
Contributor

But we could like update it automatically with a script.

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

syeopite added a commit to syeopite/instances-api that referenced this pull request Jun 19, 2021
iv-org/documentation#76

This also contains a breaking changes to the API:
  - The flag and region values has been moved. They're now within the
    country dict on the JSON response
@SamantazFox

Copy link
Copy Markdown
Member

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)

@syeopite
syeopite marked this pull request as draft June 19, 2021 15:28
syeopite added a commit to syeopite/documentation that referenced this pull request Jun 27, 2021
@syeopite
syeopite force-pushed the alt-instance-list branch from 5c48b3c to d4f2fbc Compare June 27, 2021 18:29
@syeopite
syeopite marked this pull request as ready for review June 27, 2021 19:42
@syeopite

Copy link
Copy Markdown
Member Author

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

@syeopite syeopite mentioned this pull request Jul 14, 2021
@syeopite

Copy link
Copy Markdown
Member Author

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

@syeopite syeopite mentioned this pull request Jul 24, 2021
@SamantazFox

Copy link
Copy Markdown
Member

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

@syeopite

Copy link
Copy Markdown
Member Author

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
syeopite force-pushed the alt-instance-list branch from 5017f2a to 84928c8 Compare July 28, 2021 11:44
@syeopite
syeopite force-pushed the alt-instance-list branch 2 times, most recently from 090e12c to ebedd3a Compare August 12, 2021 07:36
syeopite added a commit to syeopite/instances-api that referenced this pull request Aug 15, 2021
@TheFrenchGhosty
TheFrenchGhosty marked this pull request as draft October 3, 2021 17:08
@unixfox unixfox closed this Dec 16, 2024
@syeopite
syeopite deleted the alt-instance-list branch December 16, 2024 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Work In Progress

Development

Successfully merging this pull request may close these issues.

6 participants