diff --git a/src-docs/src/views/form_validation/form_validation_example.js b/src-docs/src/views/form_validation/form_validation_example.js index 7924c51148..b2df118557 100644 --- a/src-docs/src/views/form_validation/form_validation_example.js +++ b/src-docs/src/views/form_validation/form_validation_example.js @@ -39,7 +39,7 @@ export const FormValidationExample = { OuiFormRow components. Errors are optional and are passed as an array in case you need to list more than one. You can also hide the callout by passing - invalidCallout=“none“ + invalidCallout=“none“.

), source: [ diff --git a/src-docs/src/views/guidelines/getting_started.md b/src-docs/src/views/guidelines/getting_started.md index 9c2d1a49a2..98082bb76c 100644 --- a/src-docs/src/views/guidelines/getting_started.md +++ b/src-docs/src/views/guidelines/getting_started.md @@ -19,7 +19,7 @@ yarn add @opensearch-project/oui @elastic/datemath moment prop-types We depend upon the version of node defined in [.nvmrc](.nvmrc). -You will probably want to install a node version manager. [nvm](https://github.com/creationix/nvm) is recommended. +We recommend installing a node version manager: [nvm](https://github.com/nvm-sh/nvm) is recommended. To install and use the correct node version with `nvm`: @@ -29,7 +29,7 @@ nvm install ### Documentation -You can run the documentation locally at [http://localhost:8030/](http://localhost:8030/) by running the following. +You can run the documentation locally at [http://localhost:8030/](http://localhost:8030/) by running the following: ```js yarn @@ -51,9 +51,7 @@ OUI also has `moment` and `@elastic/datemath` as dependencies itself. These are 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 is published through [NPM](https://www.npmjs.com/package/@opensearch-project/oui) as a dependency. We also provide a starter projects for: -- [GatsbyJS](https://github.com/elastic/gatsby-oui-starter) -- [NextJS](https://github.com/elastic/next-oui-starter) +OUI is published through [NPM](https://www.npmjs.com/package/@opensearch-project/oui) as a dependency. ### Components @@ -100,12 +98,6 @@ Other compiled themes include: ```js import '@opensearch-project/oui/dist/oui_theme_dark.css'; ``` -```js -import '@opensearch-project/oui/dist/oui_theme_cascadia_light.css'; -``` -```js -import '@opensearch-project/oui/dist/oui_theme_cascadia_dark.css'; -``` ### Using our Sass variables on top of compiled CSS @@ -125,11 +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'; ``` -If you want to use the new, but in progress Cascadia theme, you can import it similarly. - -```scss -@import '@opensearch-project/oui/src/themes/oui-cascadia/oui_cascadia_colors_light.scss'; -@import '@opensearch-project/oui/src/themes/oui-cascadia/oui_cascadia_globals.scss'; ``` ### Using Sass to customize OUI @@ -157,13 +144,6 @@ By default, OUI ships with a font stack that includes some outside, open source @import url('https://rsms.me/inter/inter-ui.css'); ``` -The Cascadia theme uses the latest version of Inter that can be grabbed from Google Fonts as well. - -```scss -// index.scss -@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=Roboto+Mono:ital,wght@0,400;0,700;1,400;1,700&display=swap'); -``` - ### Reusing the variables in JavaScript The Sass variables are also made available for consumption as json files. This enables reuse of values in css-in-js systems like [styled-components](https://www.styled-components.com). As the following example shows, it can also make the downstream components theme-aware without much extra effort: