Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alternative take on the instance list rewrite #76

Draft
wants to merge 23 commits into
base: master
Choose a base branch
from

Conversation

syeopite
Copy link
Member

@syeopite syeopite commented May 30, 2021

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

instances.yaml Outdated Show resolved Hide resolved
instances.yaml Outdated Show resolved Hide resolved
@trentwiles
Copy link
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
Copy link
Member

unixfox commented Jun 9, 2021

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
Contributor

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

@unixfox
Copy link
Member

unixfox commented Jun 9, 2021

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
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
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 marked this pull request as ready for review June 27, 2021 19:42
@syeopite
Copy link
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
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
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
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 added a commit to syeopite/documentation that referenced this pull request Aug 15, 2021
syeopite added a commit to syeopite/instances-api that referenced this pull request Aug 15, 2021
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