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

Update Developer guide #16

Closed
wants to merge 2 commits into from
Closed

Update Developer guide #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4736cdc
Fix Dev guide for new repo
rupal-bq Jan 6, 2023
a631872
Update dev doc
rupal-bq Jan 6, 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
15 changes: 6 additions & 9 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,12 @@ another JDK installation, e.g. `RUNTIME_JAVA_HOME=/usr/lib/jvm/jdk-8`.

1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory.
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.
1. Check out this package from version control into the `plugins/dashboards-reporting` 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 plugins/dashboards-reporting
git checkout main
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if it's intentional but the first command clones dashboards-reporting, the second command checks out main of dashboards core. also checkout main of reporting is not necessary since it's default

maybe

cd plugins
git clone https://github.com/opensearch-project/dashboards-reporting.git

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this. It was not intentional. Please check #18

```
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