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

[Backport 2.x] Update Developer guide #20

Merged
merged 1 commit into from
Jan 6, 2023
Merged

[Backport 2.x] Update Developer guide #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,10 @@ another JDK installation, e.g. `RUNTIME_JAVA_HOME=/usr/lib/jvm/jdk-8`.
1. Create a `plugins` directory inside the OpenSearch Dashboards source code directory, if `plugins` directory doesn't exist.
1. Check out this package from version control into the `plugins` directory.
```
git clone [email protected]:opensearch-project/dashboards-reports.git plugins --no-checkout
cd plugins
echo 'dashboards-reports/*' >> .git/info/sparse-checkout
git config core.sparseCheckout true
git checkout dev
git clone https://github.com/opensearch-project/dashboards-reporting.git
```
1. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards/plugins/dashboards-reports`.
1. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards/plugins/dashboards-reporting`.

Ultimately, your directory structure should look like this:

Expand All @@ -39,14 +36,14 @@ Ultimately, your directory structure should look like this:
.
├── OpenSearch-Dashboards
│ └──plugins
│ └── dashboards-reports
│ └── dashboards-reporting
```

## Build

To build the plugin's distributable zip simply run `yarn build`.

Example output: `./build/reports-dashboards-0.0.1.zip`
Example output: `./build/reports-dashboards-*.zip`

## Run

Expand Down