-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
add initial minimal plugins docs #3272
add initial minimal plugins docs #3272
Conversation
andrewm4894
commented
May 31, 2023
- add plugins section to docs
- add getting started page with a quick example
- add a plugin list page to maintain list of popular plugins.
You probably shouldn't use images where the plugin failed as an example in |
Yeah not sure if it actually did fail or not. Need understand more what that means. Maybe we should use the url example as would be better and probably closer to the point of it. |
updated images to be better examples |
## Quick Start | ||
|
||
Use the "Web Retriever" plugin by adding this url: | ||
https://web-retriever-draganjovanovich.vercel.app/ai-plugin.json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dragan's web-retriever will hopefully soon be one of the default plugins that are part of the inference server. When it works correctly we will add it as default option (inactive by default) to the Plugins UI which will make it very simple to activate it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see #3277
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah - unsure if should just merge this PR and then just do small PR to update the docs again when FE ready?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will update the url to be the OA hosted one for sure as soon as its available
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should only include OA-provided plugins in this doc, otherwise we will probably end up with many PRs of everyone trying to advertise their own plugins. Web retriever will be merged soon (probably today) so we can edit this and then merge after
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah was wondering, although could be nice to just maintain a list of community plugins below the OA ones and then just clearly differentiate between the two and add lots of disclaimers that the community ones are unofficial.
We could only add decent ones then that the community itself has found useful. Would be nice to have them discoverable in some way. Might help encourage bit of an ecosystem around them too.
I could rejig the PR to show sort of what I mean about distinguishing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Influx does a good job on this with telegraf plugins for example.
https://docs.influxdata.com/telegraf/v1.26/plugins/
Obviously we don't need to overdo any of this either since probably be small enough list to start with.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i propose we merge this as a starting point and im happy to keep iterating on it (im small fresh pr's) and update as plugins change. for example once this merged ill need to update corresponding docs etc (e.g. url and info links): #3277 this is fine though as expecting will all be changing a lot - better to have something rather than nothing in the docs and build from there being the thinking. |
❌ pre-commit failed. |
❌ pre-commit failed. |