Add a "Project URL" to the Plugins list
rojosinalma opened this issue · comments
Is your feature request related to a problem? Please describe.
The problem:
Now that there's plenty of plugins being supported by asdf, the plugin list may seem like a random word list that doesn't really describe what each plugin does or to what project it belongs, leaving the user hung up on the relationship between a plugin and the project it relates to.
Describe the solution you'd like
Add another column to the "All Plugins" section called "Project URL" that links to the base project.
Describe similar asdf features and why they are not sufficient
There's nothing in asdf right now that points to the project a plugin may relate to.
The only option is to click on the plugin link listed and hope the author of the plugin has a link somewhere that explains to what project their plugin is related.
Describe workarounds you've considered
Just as a start it would be nice to have a third column in the "All plugins" section of the asdf website, but ideally there should be more info about this in the plugin itself in both the plugin codebase and the plugin info in the asdf cli.
Additional context
The idea is really that simple and it comes from the frustration of browsing through the plugins list and finding that some of them have no reference to the core project they relate to. This is not only useful for beginners that just wanna find new tools to work with, but also for more seasoned people who really don't know what every plugin is for.
I can create a PR to begin with, but it would be ideal that this becomes a standard for new plugins. So to get listed, you should also add basic info that points to the core project your plugin relates to in both the plugin codebase and asdf website.
I added a draft PR to kickstart this, it would be nice to get some contributions on it as the list for plugins is pretty long.
Instead of adding a new column, I just added the source link to the name in the first column, it seems less cluttered this way.
Also, I won't add more source links to the PR until I get some feedback, it would be a pain in the ass having to rewrite the whole README if someone doesn't like something about it. You can already get a pretty good idea of how it would look like with what's currently in the PR.
cc: @smorimoto @vic
Any chances that this get either rejected or approved?
I don't mind being told no, I just don't want this to go stale.
cc @jthegedus
Hi @rojosinalma thanks for your suggestion. I personally don't think this is going to be that useful. Most people know the tool they're installing ahead of time and just need to know if it's available.
The plugin author should have a link to the original tool in their READMEs and the users should be reading these repos before installing. We have a lot of work to do on the comms there about security and trust.