Skip to content

Commit

Permalink
Update dev doc for new repo (#18)
Browse files Browse the repository at this point in the history
Signed-off-by: Rupal Mahajan <maharup@amazon.com>

Signed-off-by: Rupal Mahajan <maharup@amazon.com>
  • Loading branch information
rupal-bq committed Jan 6, 2023
1 parent f9450c4 commit 7bb7e2b
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions DEVELOPER_GUIDE.md
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 git@github.com: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

0 comments on commit 7bb7e2b

Please sign in to comment.