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.

Sign up for GitHub

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

[DEVELOPER_GUIDE] resolving links #3989

Merged
merged 6 commits into from
Jun 20, 2023
Merged

[DEVELOPER_GUIDE] resolving links #3989

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d595538
links
Aigerim-ai May 6, 2023
7af5629
new section for doveloper guide
Aigerim-ai May 6, 2023
f26965e
updates
Aigerim-ai May 21, 2023
0247960
Update DEVELOPER_GUIDE.md
Aigerim-ai Jun 1, 2023
8c4727a
Merge branch 'main' into #778
joshuarrrr Jun 13, 2023
0ffcee8
Update DEVELOPER_GUIDE.md
joshuarrrr Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- README.md for dataSource and dataSourceManagement Plugin ([#2448](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2448))
- Updates functionl testing information in Testing.md ([#2492](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2492))
- Fixes typo in TSVB README ([#3518](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3518))
- Add plugin development section in DEVELOPER_GUIDE.md ([#778](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3989))

### 🛠 Maintenance

Expand Down
8 changes: 8 additions & 0 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -227,6 +228,13 @@ $ 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 simplifies the process of creating an OpenSearch Dashboards plugin by setting up the initial project structure and providing build scripts. It enables developers to focus on the core functionality and customization of their plugins, thereby enhancing the data visualization and management capabilities of OpenSearch Dashboards.

The osd-plugin-generator is a tool available in the OpenSearch Dashboards repository. It allows you to generate an OpenSearch Dashboards plugin. OpenSearch Dashboards is an open-source project that provides a web interface for data visualization and management in the OpenSearch ecosystem.
[osd-plugin-generator](https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/packages/osd-plugin-generator)
Aigerim-ai marked this conversation as resolved.
Show resolved Hide resolved

joshuarrrr marked this conversation as resolved.
Show resolved Hide resolved

#### Other snapshot configuration options

Additional options can be passed after `yarn opensearch snapshot` to further configure the cluster snapshot.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,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