[DEVELOPER_GUIDE] resolving links (#3989)

* links Signed-off-by: Aigerim Suleimenova <[email protected]> * new section for doveloper guide Signed-off-by: Aigerim Suleimenova <[email protected]> * updates Signed-off-by: Aigerim Suleimenova <[email protected]> * Update DEVELOPER_GUIDE.md Co-authored-by: Ashwin P Chandran <[email protected]> Signed-off-by: Aigerim Suleimenova <[email protected]> * Update DEVELOPER_GUIDE.md Signed-off-by: Josh Romero <[email protected]> --------- Signed-off-by: Aigerim Suleimenova <[email protected]> Signed-off-by: Josh Romero <[email protected]> Co-authored-by: Ashwin P Chandran <[email protected]> Co-authored-by: Josh Romero <[email protected]>
opensearch-project · Jun 20, 2023 · 1728318 · 1728318
1 parent 2322c53
commit 1728318
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -37,6 +37,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 - [Doc] Add COMMUNICATIONS.md with info about Slack, forum, office hours ([#3837](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3837))
 - [Saved Object Service] Adds design doc for new Saved Object Service Interface for Custom Repository [#3954](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3954)
+- Add plugin development section in DEVELOPER_GUIDE.md ([#778](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3989))
 
 ### 🛠 Maintenance
 

diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -13,6 +13,7 @@ This guide applies to all development within the OpenSearch Dashboards project a
   - [Next Steps](#next-steps)
 - [Alternative development installations](#alternative-development-installations)
   - [Optional - Run OpenSearch with plugins](#optional---run-opensearch-with-plugins)
+  - [Plugin development](#plugin-development)
   - [Alternative - Run OpenSearch from tarball](#alternative---run-opensearch-from-tarball)
   - [Configure OpenSearch Dashboards for security](#configure-opensearch-dashboards-for-security)
 - [Building artifacts](#building-artifacts)
@@ -231,6 +232,9 @@ $ yarn opensearch snapshot --P https://repo1.maven.org/maven2/org/opensearch/plu
 
 Note - if you add the [`security` plugin](https://github.com/opensearch-project/security), you'll also need to [configure OpenSearch Dashboards for security](#configure-opensearch-dashboards-for-security).
 
+### Plugin development
+The osd-plugin-generator tool makes it easier to create a plugin for OpenSearch Dashboards. It sets up the basic structure of the project and provides scripts to build it. Refer to [osd-plugin-generator](https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/packages/osd-plugin-generator) for more details.
+
 #### Other snapshot configuration options
 
 Additional options can be passed after `yarn opensearch snapshot` to further configure the cluster snapshot.

diff --git a/README.md b/README.md
@@ -53,4 +53,4 @@ Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.
 [codecov-badge]: https://codecov.io/gh/opensearch-project/OpenSearch-Dashboards/branch/main/graphs/badge.svg
 [codecov-link]: https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards
 [link-checker-badge]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/links_checker.yml/badge.svg
-[link-checker-link]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/links_checker.yml
+[link-checker-link]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/links_checker.yml