gadgets: Add README.md for image-based gadgets #2726
Conversation
|
I am putting this on hold till #2736 is fixed |
| Gather information about running processes. | ||
| --- | ||
|
|
||
| > ⚠️ This feature is experimental and could change without prior notification. Check the installation guide to enable [experimental features](../../docs/getting-started/install-linux.md#experimental-features). |
There was a problem hiding this comment.
Since this doc aims to be published on artifacthub and all gadgets published on artifacthub are necessarily image-based gadgets, I suggest to remove that line: this image-based gadget is not more experimental than other image-based gadgets.
What do you think?
There was a problem hiding this comment.
What do you think?
The main reason to include it here is to ensure the user doesn't get any surprises with kubectl gadget run snapshot_process like they need to deploy Inspektor Gadget with experimental to be able to follow steps on this guide?
There was a problem hiding this comment.
Or perhaps we should rephrase it to say This feature requires Inspektor Gadget has been installed with experimental features enabled ?
Signed-off-by: Qasim Sarfraz <qasimsarfraz@microsoft.com>
mqasimsarfraz
force-pushed
the
qasim/docs-image-based-gadgets
branch
from
950ae20
to
0a480eb
Compare
Add README.md for image-based gadgets. This should be used by artifacthub to show the documentation for individual gadgets as well!
Related #2727
This PR only adds documentation for following gadgets: