-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
feat(core): add installation command to the documentation #2967
Conversation
Quality Gate passedKudos, no new issues were introduced! 0 New issues |
febd835
to
51d21c8
Compare
## Installation | ||
|
||
If you use one of our Docker images tagged __*-full__, this plugin is already included. | ||
If not, you can install it with the following command: | ||
|
||
```shell | ||
./kestra plugins install io.kestra.plugin:{{ name }}:LATEST | ||
``` | ||
|
||
This command will automatically install the latest available version. You can replace `LATEST` with a specific version or a version range like `[0.12,0.13.0-SNAPSHOT)`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Installation | |
If you use one of our Docker images tagged __*-full__, this plugin is already included. | |
If not, you can install it with the following command: | |
```shell | |
./kestra plugins install io.kestra.plugin:{{ name }}:LATEST | |
``` | |
This command will automatically install the latest available version. You can replace `LATEST` with a specific version or a version range like `[0.12,0.13.0-SNAPSHOT)`. | |
::alert{type="info"} | |
If you use a [base Docker image](https://kestra.io/docs/installation/docker#official-docker-images) without plugins, you can install the plugin using the following command: | |
```shell | |
./kestra plugins install io.kestra.plugin:{{ name }}:LATEST |
You can replace LATEST
with a specific version or a version range e.g. [0.14,0.15.0-SNAPSHOT)
.
::
This looks like a great addition. As discussed, it would be awesome to include it as a short info box right before the Properties. The decision to include it is motivated by customers' requests who found this command really useful + it's a helpful reminder to install a plugin if not available yet. |
closing for now in favor of #3174 |
This will add the following section on top of the plugin documentation page (unless it's the core plugin):
Installation
If you use one of our Docker images tagged *-full this plugin is already included.
If not, you can install it with the following command:
This command will automatically install the latest available version. You can replace
LATEST
with a specific version or a version range like[0.12,0.13.0-SNAPSHOT)
.