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

Improve plugin documentation #1963

Closed
2opremio opened this issue Oct 28, 2016 · 5 comments
Closed

Improve plugin documentation #1963

2opremio opened this issue Oct 28, 2016 · 5 comments
Labels
chore Related to fix/refinement/improvement of end user or new/existing developer functionality component/docs A documentation issue

Comments

@2opremio
Copy link
Contributor

We should improve the plugin documentation to encourage people to write plugins and get started quickly.

We could do several things:

  • Improve the current documentation
  • Write a guide
  • Explain the data structures better
@2opremio 2opremio added component/docs A documentation issue chore Related to fix/refinement/improvement of end user or new/existing developer functionality labels Oct 28, 2016
@2opremio 2opremio added this to the improve plugin docs milestone Oct 28, 2016
@2opremio
Copy link
Contributor Author

@abuehrle This work is going to be done by the Kinvolk guys, probably @alepuccetti but it would be really helpful if you could oversee it and provide guidelines on how to extend https://www.weave.works/documentation/scope-latest-plugins/

@davkal
Copy link
Contributor

davkal commented Oct 28, 2016

The GH org is great for hosting the plugin code, but we still need some kind of Yahoo-ish directory for plugins that makes it easier to browse them. It would be great to have that as a separate page to the guide.
I’d like to get people thinking in terms of categories, like datasource plugins, or metrics plugins, or decorator plugins, or control plugins. These categories are just a proposal.

@alepuccetti
Copy link

This is a first step redirecting users to the new plugin organization.

#1906

@alepuccetti
Copy link

https://www.weave.works/documentation/scope-latest-plugins/

Is this page generated from this file https://github.com/weaveworks/scope/blob/master/examples/plugins/README.md? So I should start my work from there?

@2opremio
Copy link
Contributor Author

Is this page generated from this file https://github.com/weaveworks/scope/blob/master/examples/plugins/README.md? S

No, it comes from https://github.com/weaveworks/scope/blob/master/site/plugins.md . Please coordinate the changes under site/ with @abuehrle

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Related to fix/refinement/improvement of end user or new/existing developer functionality component/docs A documentation issue
Projects
None yet
Development

No branches or pull requests

3 participants