Skip to content

Commit

Permalink
Update getting_started.md to remove elastic reference and other chang…
Browse files Browse the repository at this point in the history
…es (#502)

Signed-off-by: manasvinibs <[email protected]>
  • Loading branch information
manasvinibs authored Feb 28, 2023
1 parent fb2a386 commit a657d1f
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src-docs/src/views/guidelines/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ OUI also has `moment` and `@elastic/datemath` as dependencies itself. These are

## What's available

OUI publishes React UI components, JavaScript helpers called services, and utilities for writing Jest tests. Please refer to the [OpenSearch UI Framework website](https://elastic.github.io/eui) for comprehensive info on what's available.
OUI publishes React UI components, JavaScript helpers called services, and utilities for writing Jest tests. Please refer to the [OpenSearch UI Framework website](https://oui.opensearch.org) for comprehensive info on what's available.

OUI is published through [NPM](https://www.npmjs.com/package/@opensearch-project/oui) as a dependency.

Expand Down Expand Up @@ -117,8 +117,6 @@ For the dark theme, swap the first import for the dark colors file.
@import '@opensearch-project/oui/src/themes/oui/oui_globals.scss';
```

```
### Using Sass to customize OUI

OUI's Sass themes are token based, which can be altered to suite your theming needs like changing the primary color. Simply declare your token overrides before importing the whole OUI theme. This will re-compile **all of the OUI components** with your colors.
Expand Down Expand Up @@ -201,11 +199,11 @@ We do not recommend customizing OUI components by applying styles directly to OU

## Using the test environment build

OUI provides a separate babel-transformed and partially mocked commonjs build for testing environments in consuming projects. The output is identical to that of `lib/`, but has transformed async functions and dynamic import statements, and also applies some useful mocks. This build mainly targets Kibana's Jest environment, but may be helpful for testing environments in other projects.
OUI provides a separate babel-transformed and partially mocked commonjs build for testing environments in consuming projects. The output is identical to that of `lib/`, but has transformed async functions and dynamic import statements, and also applies some useful mocks. This build mainly targets OpenSearch Dashboards Jest environment, but may be helpful for testing environments in other projects.

### Mapping to the `test-env` directory

In Kibana's Jest configuration, the `moduleNameMapper` option is used to resolve standard OUI import statements with `test-env` aliases.
In OpenSearch Dashboards Jest configuration, the `moduleNameMapper` option is used to resolve standard OUI import statements with `test-env` aliases.

```js
moduleNameMapper: {
Expand Down

0 comments on commit a657d1f

Please sign in to comment.