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

feat(core): add installation command to the documentation #2967

Closed
wants to merge 1 commit into from

Conversation

loicmathieu
Copy link
Member

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:

./kestra plugins install io.kestra.plugin:plugin-script-shell: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).

Copy link

sonarcloud bot commented Feb 1, 2024

@loicmathieu loicmathieu marked this pull request as draft February 2, 2024 09:46
Comment on lines +14 to +23
## 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)`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## 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).
::

@anna-geller
Copy link
Member

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.

@anna-geller
Copy link
Member

closing for now in favor of #3174

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.

2 participants