Merge the lists of clients on the wiki and the README

[waldyrious]

Note: This has been discussed in various places (e.g. here and here), but apparently we never wrote it down into an actual issue. (The closest we got to that was a mini-project in our wiki page for Google Season of Docs, which is where most of the text below comes from.)

There are currently two lists of clients, each maintained independently: one in the README, and one in a wiki page. (There actually used to be a third one 😱 in the website, but it was merged a while ago by @20manas in tldr-pages/tldr-pages.github.io#53.)

We want the client lists to live at a single place, so that the lists won't get outdated or out of sync with each other.

The goal is to merge the two lists without losing any relevant information, and keeping the final result readable and easy to consume.

The final list can live at either of the two existing places, or at a new location (e.g. a new CLIENTS.md file). The existing locations should either embed or link to the unified list.

Once the lists are merged, we can also discuss the possibility of splitting the list into several sections based on relevant criteria (beyond the current division, which is by platform / language). For example:

• by maintenance status — we don't want to encourage people to use clients that are abandoned, outdated. etc. (see Inactive and unmaintained clients #4044, Move clients in the tldr-pages org back to the original authors #1602, Take care of unmaintained tldr repositories #1104)
• by adherence to the client spec (see Define spec for officially sanctioned clients #1065)
• Eventually, by support for new syntax (see [RFC] new syntax for pages #958, Add more fields to the commands #1082), new directory structure (see New directory structure #4120 and other issues under the architecture label), or other features (see Removal of duplicated index.json from the generated ZIP archive, up-to-date clients tracking #2865, Clients which support private pages #3269)

For convenience, here are again the links to the existing lists of clients:

• README: README.md#how-do-i-use-it
• Wiki: tldr pages clients

[MasterOdin]

My vote would be on having it just be in the wiki, which allows people to self add clients. For most projects I've seen that go this route, I'm not sure I've really seen any instance of spam or whatever on the wiki even though its publicly editable.

[bl-ue]

The only part-issue I see with that approach is that maintainers wouldn't know when there's a new client unless they're watching the repository (because GH adds an entry to your feed about users modifiying the wiki of a repo if you watching it), and they take the time to check what the user changed.

[sbrl]

Yeah, we really need to tidy this up.

The wiki would be a sensible place to put it, but we would of course need a prominent link to it in the README

[kitarp29]

@waldyrious Could you assign this to me??

[sbrl]

@kitarp29 if you could submit a pull request, that would be great @kitarp29!

[kitarp29]

@marchersimon I updated the wiki page.
How Do I create a PR?
I mean where is the source file for that wiki page?

[marchersimon]

Only members can edit the wiki pages, there's no way to open a PR unfortunately. But you could open an issue, where you paste the content.

[kitarp29]

So my contributions can't get merged? @marchersimon

[marchersimon]

I don't think so.
@sbrl @navarroaxel do you know if there would be a way?

[navarroaxel]

Based on this docs https://docs.github.com/en/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis anyone is allowed to edit the wiki, via web UI or Git repo.

[kitarp29]

I edited that already @navarroaxel

[sbrl]

That's weird, I thought for sure anyone could edit the wiki.

[sbrl]

You should be able to clone the wiki as a git repository, so if you can attach a patch file to this repo I can merge it into the wiki that way.

[MasterOdin]

@sbrl @marchersimon The wiki page was updated by @kitarp29 already: https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients/_history. I think they were looking to get a "PR merge" though for this (for hacktoberfest?), which unfortunately cannot happen as wikis don't have PRs.

The next step imo would be to probably remove the list from the README and just have it link to the wiki, which can be a PR made by @kitarp29.

[kitarp29]

@MasterOdin leave I don't want to make a PR for the sake of it. I helped very little to this repo, as I am just starting with OpenSource. You will be seeing more messages by me in this repo 🤓😅.
If the issue is resolved, please go ahead and close it.
Thanks 😊

[marchersimon]

Documentation is actually very important, don't underestimate your work. Thanks for your help!

[MasterOdin]

@marchersimon reopening this issue as the primary objective of it:

We want the client lists to live at a single place, so that the lists won't get outdated or out of sync with each other.

is still not done. We still have two lists (README.md and Wiki), and should consolidate behind one.

We should open a PR to simplify the README to just point at the wiki, and maybe mention how to install just the official clients.

[kitarp29]

@MasterOdin Can I work on it??

[marchersimon]

Sure, if you like to

[kitarp29]

@MasterOdin #7381
did the changes and updated README.md

[sbrl]

Awesome, @kitarp29! Does this mean we can close this issue now?

[kitarp29]

Yes this got merged.
Go ahead and close it.