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

Document plugins #85

Closed
na-- opened this issue Aug 18, 2020 · 4 comments
Closed

Document plugins #85

na-- opened this issue Aug 18, 2020 · 4 comments

Comments

@na--
Copy link
Member

na-- commented Aug 18, 2020

After we merge this k6 WIP PR: grafana/k6#1396 (grafana/k6#1353), but before we release k6 v0.28.0, someone has to write a docs page that explains plugins, and maybe has a very short and simple tutorial on how to write one. We should then link to that page from the v0.28.0 release notes.

Also prompted by grafana/k6#1595

Edit: as I've said many times, it's very important to stress in that docs page that this is a beta-quality feature. The current plugin API (and k6 APIs they will depend on) are not guaranteed to be stable, and plugins may need changes when we update k6.

@na--
Copy link
Member Author

na-- commented Aug 18, 2020

And, as was pointed out in grafana/k6#1595, in the plugin writing docs, it might not be a bad idea to point out that the k6 built-in modules in https://github.com/loadimpact/k6/tree/master/js/modules/k6 might offer useful usage examples to plugin writers as well. Even though the quality of some of that code might be in dire need of improvement... 😅

@simskij
Copy link
Contributor

simskij commented Aug 18, 2020

Things to do as part of this, in my opinion:

  • Docs page that explains the API, the anatomy of a plugin, and the limitations of the current implementation @loadimpact/load-generator
  • Template repo at k6io/example-plugin. @mostafa or @simskij?
  • A blog post, but we'll handle that in a separate issue.

@mostafa
Copy link
Member

mostafa commented Aug 18, 2020

@simskij and @na--,

  1. I can write the docs article and the blog post.
  2. I've made a messy template repo for the very same reason/cause, which can be improved to reflect the latest changes the plugin support PR.

@simskij
Copy link
Contributor

simskij commented Dec 17, 2020

Superseded by #169

@simskij simskij closed this as completed Dec 17, 2020
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

No branches or pull requests

3 participants