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

Update website plugins documentation #2008

Merged
merged 8 commits into from
Nov 14, 2016

Conversation

alepuccetti
Copy link

This PR adds information about plugins useful to developers who want create their own plugins, explaining the basic structure of a plugin, report and control interfaces.
Also, it adds a section about the currently implemented plugins with brief descriptions and links to the Weaveworks Plugins organization and the plugins repositories.

/cc @abuehrle can you give me some feedbacks on this first iteration about plugins documentation? I will add more information in later PRs.

/cc @2opremio

@abuehrle
Copy link
Contributor

@alepuccetti I don't seem to be able to access your branch. Can you add me to your repo and I will edit these for you.

Copy link
Contributor

@abuehrle abuehrle left a comment

Choose a reason for hiding this comment

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

I will need to see the whole file in context, as it's hard to edit just the snippets without the rest of the paragraphs.


There are currently two different examples:
You can find all the official plugins at [Weaveworks Plugins](https://github.com/weaveworks-plugins).

This comment was marked as abuse.

@alepuccetti
Copy link
Author

alepuccetti commented Nov 11, 2016

@abuehrle I pushed the same branch on my personal repo and sent you an invite to collaborate on that. This should be enough to allow you to make changes, I will push your changes here later.

Sorry for the inconvenient, but I cannot change the permission on the Kinvolk repo.

Alessandro Puccetti and others added 8 commits November 14, 2016 14:12
The plugins now are hosted in a new organization [Weaveworks Plugins]
(https://github.com/weaveworks-plugins).
This patch updates the list of the available plugins and their links to the new
repositories.
This patch updates the plugins description on registration and reporting.
This patch adds the documentation on the node naming conventions and rules.
This path adds a guide with code examples based on the Scope IOWait plugin
on how to develop a plugin for scope.
@2opremio
Copy link
Contributor

LGTM, but I would like @abuehrle to also sign-off on this one before merging. @abuehrle Are you OK with this PR?

@abuehrle
Copy link
Contributor

LGTM

alepuccetti pushed a commit to kinvolk-archives/scope that referenced this pull request Nov 14, 2016
This patch applies the same changes from the review of
weaveworks#2008
@2opremio 2opremio merged commit b11cfb0 into weaveworks:master Nov 14, 2016
@2opremio
Copy link
Contributor

2opremio commented Nov 14, 2016

I have republished the docs: https://www.weave.works/documentation/scope-latest-plugins/

fbarl pushed a commit that referenced this pull request Nov 15, 2016
This patch applies the same changes from the review of
#2008
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants