Skip to content

Commit

Permalink
Separate developer_guide.md
Browse files Browse the repository at this point in the history
Signed-off-by: Joshua Li <[email protected]>
  • Loading branch information
joshuali925 committed Jun 23, 2021
1 parent f16ec1b commit 3edd850
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 51 deletions.
52 changes: 52 additions & 0 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
## Developer Guide

So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.

### Setup

1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L5).
1. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L5) you want to set up.

1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory.
1. cd into the OpenSearch Dashboards source code directory.
1. Check out this package from version control into the `plugins` directory.
```
rm plugins -r
git clone [email protected]:opensearch-project/dashboards-visualizations.git plugins --no-checkout
cd plugins
echo 'gantt-chart/*' >> .git/info/sparse-checkout
git config core.sparseCheckout true
git checkout main
```
6. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards` directory.

Ultimately, your directory structure should look like this:

```md
.
├── OpenSearch Dashboards
│ └── plugins
│ └── gantt-chart
```


### Build

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

Example output: `./build/ganttchartDashboards*.zip`


### Run

- `yarn start`

Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`.

- `npx cypress run`

Runs the plugin cypress tests.

### Submitting Changes

See [CONTRIBUTING](CONTRIBUTING.md).
60 changes: 9 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,70 +7,28 @@ The OpenSearch Dashboards Visualizations enables you to use additional types of

Please see our technical [documentation](https://docs-beta.opensearch.org/dashboards/gantt/) to learn more about its features.

## Contributing

## Setup
See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).

1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L5).
1. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L5) you want to set up.
## Getting Help

1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory.
1. cd into the OpenSearch Dashboards source code directory.
1. Check out this package from version control into the `plugins` directory.
```
rm plugins -r
git clone [email protected]:opensearch-project/dashboards-visualizations.git plugins --no-checkout
cd plugins
echo 'gantt-chart/*' >> .git/info/sparse-checkout
git config core.sparseCheckout true
git checkout main
```
6. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards` directory.
If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.

Ultimately, your directory structure should look like this:

```md
.
├── OpenSearch Dashboards
│ └── plugins
│ └── gantt-chart
```


## Build

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

Example output: `./build/ganttchartDashboards*.zip`


## Run

- `yarn start`

Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`.

- `npx cypress run`

Runs the plugin cypress tests.


## Contributing to OpenSearch Dashboards Visualizations

We welcome you to get involved in development, documentation, testing the visualizations plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in.
For more information, see [project website](https://opensearch.org/) and [documentation](https://docs-beta.opensearch.org/). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/).

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Bugs, Enhancements or Questions
## Security

Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opensearch-project/dashboards-visualizations/issues).
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.

## License

This code is licensed under the Apache 2.0 License.
This project is licensed under the [Apache v2.0 License](LICENSE.txt).

## Copyright

Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

0 comments on commit 3edd850

Please sign in to comment.