Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 3.2 KB

DEVELOPER_GUIDE.md

File metadata and controls

80 lines (50 loc) · 3.2 KB
Raw

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.

Forking and Cloning

Fork this repository on GitHub, and clone locally with git clone.

Install Prerequisites

You will need to install node.js, nvm, and yarn in your environment to properly pull down dependencies to build and bootstrap the plugin.

Environment Setup

  1. Download OpenSearch for the version that matches the OpenSearch Dashboard version specified in package.json.

  2. Download and install the appropriate OpenSearch ML Commons plugin.

  3. Download the OpenSearch-Dashboards source code for the version specified in package.json you want to set up.

    See the OpenSearch Dashboards developer guide for more instructions on setting up your development environment.

  4. Change your node version to the version specified in .node-version inside the OpenSearch-Dashboards root directory.

  5. cd into the plugins directory of the OpenSearch-Dashboards source code directory.

  6. Check out this package from version control into the plugins directory.

  7. Set assistant.chat.enabled to true in opensearch_dashboards.yml if you want to enable the chat feature.

  8. Run yarn osd bootstrap inside Opensearch-Dashboards/plugins/dashboards-assistant.

Ultimately, your directory structure should look like this:

.
├── OpenSearch-Dashboards
│   └── plugins
│       └── dashboards-assistant

Build

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

Example output: ./build/assistantDashboards-2.11.0.zip

Run

  • yarn start

    • Starts OpenSearch-Dashboards and includes this plugin. OpenSearch-Dashboards will be available on localhost:5601.
    • Please run in the OpenSearch-Dashboards root directory
    • You must have OpenSearch running with the ML Commons plugin

Test

There are unit/stubbed integration tests.

  • yarn test

    • Runs the plugin unit tests.

Formatting

This codebase uses Prettier as our code formatter. All new code that is added has to be reformatted using the Prettier version listed in package.json. In order to keep consistent formatting across the project developers should only use the prettier CLI to reformat their code using the following command:

yarn lint --fix

NOTE: There also exists prettier plugins on several editors that allow for automatic reformatting on saving the file. However using this is discouraged as you must ensure that the plugin uses the correct version of prettier (listed in package.json) before using such a plugin.

Backport