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

Added Plugins section with curently compatible plugins #378

Merged
merged 2 commits into from
Mar 7, 2021

Conversation

jeremymeyers
Copy link
Contributor

I made a table with all the plugins listed as compatible on #170 ... the plugin names would need to be verified in terms of being able to use them to install correctly but since there doesn't seem to be anywhere else in the docs that this lives i thought it might be a good addition.

I made a table with all the plugins listed as compatible on Flow-Launcher#170  ... the plugin names would need to be verified in terms of being able to use them to install correctly but since there doesn't seem to be anywhere else in the docs that this lives i thought it might be a good addition.
@JohnTheGr8
Copy link
Member

Quick thoughts:

  1. listing plugins that have not been ported to this project in its Readme will probably confuse people, especially with the text Here are some actively maintained plugins you can install.
  2. the first two columns can be merged into one to make this less noisy (visually)
  3. in my opinion the last column can be omitted

@jeremymeyers
Copy link
Contributor Author

@JohnTheGr8 the "not ported" denotes plugins that were created for Wox that run in Flow without needing to make any changes. The language could be clearer.

@jjw24
Copy link
Member

jjw24 commented Mar 5, 2021

@jeremymeyers I think it would be better to reference this table in our documentation site instead.

What do you guys think if we:

  • move Usage section above Integrations
  • include it in Integrations section as another bullet point instead.
  • A simple one liner for the bullet point along the lines of: Flow has also integrated plugins from other launchers, visit here for a list of plugins you can use from them
  • Move your Plugins section contents to the docs site: https://github.com/Flow-Launcher/docs as a brand new page called Migrated Plugins (or whatever heading you see fit)

The reason for this is because I would think it's better to keep the readme light and concise, only the necessary information for new users that is needed to get going. Advanced users as well as launcher users can dig into the doco site to find out more what Flow offers additionally.

Let me know what you guys think.

@jeremymeyers
Copy link
Contributor Author

works for me, i just kinda wanted to get it started

@jjw24
Copy link
Member

jjw24 commented Mar 5, 2021

You can make the changes to the same pr here, and let me know when you have PRed the docs repo

@jeremymeyers
Copy link
Contributor Author

New doc repo is here Flow-Launcher/docs#6 ... will make changes to readme.md in a sec

Moved plugins to its own file (commit needs to be accepted before the link here will work), switched Usage and Integrations
Comment on lines +64 to +67
## Plugins

There is a [list of actively maintained plugins](https://github.com/Flow-Launcher/docs/Plugins.md) in the documentation section, some of which are integrated from other launchers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of a separate section, could this be just a bullet point in Integrations section please

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it can though i made it a separate thing because I'm not sure an average user would think to look for plugin installation information under an "integrations" section and the extensibility is a core Flow feature. (my focus generally is documentation UX). But happy to do whatever.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Let's keep this section then, once the python auto install feature is rolled out I might merge Integration into the Plugin section as well so we can just use it as a quick guide on using plugins and where to find more info

@jjw24 jjw24 added the enhancement New feature or request label Mar 7, 2021
@jjw24 jjw24 merged commit 8a8eea8 into Flow-Launcher:dev Mar 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants