opensearch-project / OpenSearch-Dashboards

📊 Open source visualization dashboards for OpenSearch.
https://opensearch.org/docs/latest/dashboards/index/
Apache License 2.0
1.63k stars 847 forks source link

Creating OpenSearch Dashboard Plugin #5755

Open Rohr2827 opened 6 months ago

Rohr2827 commented 6 months ago

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?

abbyhu2000 commented 5 months ago

@manasvinibs share the links related to the topics.

manasvinibs commented 5 months ago

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/