Skip to content

[DOC] document download URL for core plugins #9606

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

Merged
merged 4 commits into from
Apr 14, 2025

Conversation

reta
Copy link
Contributor

@reta reta commented Apr 13, 2025

Description

Document download URL for core plugins

Issues Resolved

Closes #8763

Version

All

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@kolchfa-aws @reta LGTM with one comment. Thanks!

@@ -303,6 +303,22 @@ _<sup>1</sup>Dashboard Notebooks was merged in to the Observability plugin with
_<sup>2</sup>Performance Analyzer is not available on Windows._


### Downloading plugin distributions for offline installation

Each bundled plugin distribution can be downloaded and installed from a [zip file](#install-a-plugin-from-a-zip-file) offline using the official `plugins` repository URL template:
Copy link
Collaborator

Choose a reason for hiding this comment

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

"from an offline zip file"?

Copy link
Collaborator

Choose a reason for hiding this comment

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

The file itself is hosted online. The installation happens offline.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'll change the word order so it's clear.

@kolchfa-aws kolchfa-aws merged commit fab855b into opensearch-project:main Apr 14, 2025
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 14, 2025
* document download URL for core plugins

Signed-off-by: Andriy Redko <[email protected]>

* Doc review

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _install-and-configure/plugins.md

Signed-off-by: kolchfa-aws <[email protected]>

* Update _install-and-configure/plugins.md

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit fab855b)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@rursprung rursprung left a comment

Choose a reason for hiding this comment

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

thanks a lot for documenting this! 🙏

https://artifacts.opensearch.org/releases/plugins/<plugin-name>/<version>/<plugin-name>-<version>.zip
```

The `<plugin-name>` correponds to the name of the bundled plugin (for example, `analysis-icu`). The `<version>` must match the version of the OpenSearch distribution (for example, `2.19.1`).
Copy link
Contributor

Choose a reason for hiding this comment

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

typo:

Suggested change
The `<plugin-name>` correponds to the name of the bundled plugin (for example, `analysis-icu`). The `<version>` must match the version of the OpenSearch distribution (for example, `2.19.1`).
The `<plugin-name>` corresponds to the name of the bundled plugin (for example, `analysis-icu`). The `<version>` must match the version of the OpenSearch distribution (for example, `2.19.1`).

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you! Fixed in #9609


For example, use the following URL to download the `analysis-icu` bundled plugin distribution for OpenSearch version `2.19.1`:

```
Copy link
Contributor

Choose a reason for hiding this comment

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

you used ```html above but only ``` here - intentionally?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes. makes the text within the tags stand out. Here there are no tags so it'll be plain either way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] document download URL for core plugins
4 participants