client
client copied to clipboard
knative
Revise kn plugin document
/kind doc
Since we are moving plugins to knative-sandbox, the plugin document is out of date. We shall revise it, especially the contribution guide.
This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.
Client contrib has been archived, and we don't have a new place for this
@abrennan89 do you have a proposal where we best could place a "plugin development" documentation ? The content would contain:
- How to develop a plugin
- External vs. internal plugins
- What is the process to get a plugin into knative-sandbox
In the future, this would be a more comprehensive 'plugin developer' guide that I expect to span multiple pages.
@rhuss for now I'd just add new pages to the section https://knative.dev/docs/client/kn-plugins/
I'm not sure if the Client section will stay as-is as we move more to an admin / dev guide structure, but I think it's OK to include it there for now and we can move it later if needed. Otherwise feel free to create a new section in the Developer guide for kn plugins?
Good point, let's start like this.
However, for plugins I think we would eventually need a third category, in addition to admin and dev ("dev" actually means "knative user"): "Knative dev", who is someone who develops for kn (not with kn). We should clearly indicate which persona we target when we say "Dev" (so we could even switch to a "Knative user" wording ?)
With "Developer guide" you refer to https://github.com/knative/client/blob/main/docs/DEVELOPMENT.md ?
However, for plugins I think we would eventually need a third category, in addition to admin and dev ("dev" actually means "knative user"): "Knative dev", who is someone who develops for kn (not with kn). We should clearly indicate which persona we target when we say "Dev" (so we could even switch to a "Knative user" wording ?)
User personas are UX wheelhouse, so I'll cc @omerbensaadon for this. AFAIK we have no plans for a third category docs guide beyond admin and developer. Maybe it needs to be user, developer, and admin, but I think it would be wise to at least finish splitting the current docs into admin vs dev guides and then differentiate what's in the dev guide for user vs dev docs.
Re Developer guide, I'm referring to https://knative.dev/docs/developer/
This issue is still valid but re-reading the original ask, I think we should keep the plugin documentation (i.e. how to develop a plugin) either in https://github.com/knative/client or in https://github.com/knative-sandbox/kn-plugin-sample which could be advertised as the starting point for plugin development. However, it's really about revising the current documentation. I probably would not want it to move to knative.dev but keep it closer to the code where it can be used.