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

Creating OpenSearch Dashboard Plugin #5755

Open
Rohr2827 opened this issue Jan 30, 2024 · 2 comments
Open

Creating OpenSearch Dashboard Plugin #5755

Rohr2827 opened this issue Jan 30, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@Rohr2827
Copy link

I am creating a personal plugin for OpenSearch and have followed the DEVELOPER_GUIDE.md but am uncertain of how or where to gather more information on easy and complex tasks to improve my plugin. Currently I am creating the base plugin with the code

node scripts/generate_plugin --name my_plugin_name –y Create a default plugin
yarn plugin-helpers build Builds plugin

After this I have developed a relatively complex reporting plugin using the API with front and backend code that uses JS and typescript but am uncertain if I am doing everything the easiest way or even the desired way. In addition, I am not certain where to even start with potentially more complex tasks like getting the current logged in user info, utilizing the built in emailing, or how to change the breadcrumbs that act as tabs in your header.

Capture

In summary, is there any specific step by step guide that encompasses building a plugin from the ground up like the Reporting, Alerting, Maps, Notifications, Index Management, Snapshot Management, or Security plugins or is it something I must discover on my own?

@Rohr2827 Rohr2827 added the enhancement New feature or request label Jan 30, 2024
@abbyhu2000
Copy link
Member

@manasvinibs share the links related to the topics.

@manasvinibs
Copy link
Member

Here are some of the useful links to understand plugin development lifecycle in OpenSearch Dashboards:
How to develop simple plugin - https://cptnb.github.io/opensearch-dashboards-dev-docs/plugins/demo-plugin-tutorial/
Understanding plugin life cycle - https://opensearch.org/blog/dashboards-plugins-intro/
How to install plugin - https://cptnb.github.io/opensearch-dashboards-dev-docs/plugins/install/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants