From 2c7bc75aa5a3496f54f0a835f775277ddeae9736 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Mon, 27 Feb 2023 13:09:26 -0800 Subject: [PATCH] Remove writing guidelines (#503) (#519) Signed-off-by: manasvinibs (cherry picked from commit ea21a3ae34d08b432fad1cf5b1425e9cf8001b80) Co-authored-by: Manasvini B Suryanarayana --- src-docs/src/routes.js | 3 - src-docs/src/views/guidelines/writing.js | 861 ----------------------- 2 files changed, 864 deletions(-) delete mode 100644 src-docs/src/views/guidelines/writing.js diff --git a/src-docs/src/routes.js b/src-docs/src/routes.js index f9ed1123f2..fb98310210 100644 --- a/src-docs/src/routes.js +++ b/src-docs/src/routes.js @@ -29,8 +29,6 @@ import ColorGuidelines from './views/guidelines/colors'; import { SassGuidelines } from './views/guidelines/sass'; -import WritingGuidelines from './views/guidelines/writing'; - // Services import { ColorPaletteExample } from './views/color_palette/color_palette_example'; @@ -341,7 +339,6 @@ const navigation = [ name: 'Sass', component: SassGuidelines, }, - createExample(WritingGuidelines, 'Writing'), ], }, { diff --git a/src-docs/src/views/guidelines/writing.js b/src-docs/src/views/guidelines/writing.js deleted file mode 100644 index f923201f67..0000000000 --- a/src-docs/src/views/guidelines/writing.js +++ /dev/null @@ -1,861 +0,0 @@ -/* - * SPDX-License-Identifier: Apache-2.0 - * - * The OpenSearch Contributors require contributions made to - * this file be licensed under the Apache-2.0 license or a - * compatible open source license. - * - * Modifications Copyright OpenSearch Contributors. See - * GitHub history for details. - */ - -import React from 'react'; -import classNames from 'classnames'; - -import { GuideRule, GuideRuleExample } from '../../components'; - -import { - OuiButton, - OuiButtonEmpty, - OuiCard, - OuiCheckbox, - OuiFieldNumber, - OuiFieldPassword, - OuiFieldSearch, - OuiFieldText, - OuiFlexGrid, - OuiFlexGroup, - OuiFlexItem, - OuiFormRow, - OuiHorizontalRule, - OuiIcon, - OuiLink, - OuiPanel, - OuiSpacer, - OuiTab, - OuiTabs, - OuiText, - OuiTitle, -} from '../../../../src/components'; - -import { htmlIdGenerator } from '../../../../src/services'; - -const GuideRuleWriting = ({ children, className, ...rest }) => { - const classes = classNames(className); - - return ( - -

{children}

-
- ); -}; - -export default { - title: 'Writing Guidelines', - intro: ( - <> - -

- You can have the most beautiful UI, but without{' '} - consistent, easy-to-understand text, you haven’t built the best - user experience. -

-
- - - - - - - - - - - - - - - - - - - ), - sections: [ - { - title: 'Capitalization', - wrapText: false, - text: ( - <> - - - - Create index patterns - - - - - - Create Index Patterns - - - - - - - - Set up index pattern - - - - - Set Up Index Pattern - - - - - - - - Inventory - Metrics Explorer - - - - - Inventory - Metrics explorer - - - - - - - ), - }, - { - title: 'Writing style', - wrapText: false, - text: ( - <> - - - - The Elasticsearch Query DSL builds filters. - - - - - Filters are built using the Elasticsearch Query DSL. - - - - - - - -

Edit saved objects

-
-
- - - -

Edit saved objects

-

- From here, you can edit saved objects. To get started, follow - these steps. -

-
-
-
- - - - - Configure at least one index pattern. - - - - - In order to use Kibana, you must configure at least one index - pattern. - - - - - - - - No active shard records for this cluster. - - - - - There are currently no active shard records for this cluster. - - - - - - - Create component template - - - Create a new component template - - - - - ), - }, - { - title: 'Addressing the user', - wrapText: false, - text: ( - <> - - - - You must configure TLS to apply a Platinum license. - - - - - - Configuring TLS will be required to apply a Platinum license. - - - - - - - - We noticed that you don't have any data in your cluster. - Try our sample data and dashboards or jump in with your own - data. - - - - - Let's create a database - - Let's create a visualization - - ... - - - - - - Explore on my own - - - - - I agree to follow the terms of service - - - - - - ), - }, - { - title: 'Punctuation', - wrapText: false, - text: ( - <> - - - - - - - - - - - - - - - - - - - - - - - - - - - - Accepts 1–5. Learn more. - - }> - - - - - - - Index management - - - Update your Elasticsearch indices individually or in bulk - - - - - - - - Didn't find what you were looking for? - - - - - Did not find what you were looking for? - - - - - - - - This dashboard is empty. Fill it up! - - - - - Couldn't find any Elasticsearch data! - - - - - - ), - }, - { - title: 'Messages', - wrapText: false, - text: ( - <> - - - - This dashboard is empty - - -

- To add a visualization, click Add in the menu bar. No - visualizations yet? Go to Visualize to create one. -

-
-
- - - - Uh-oh! - - -

- This dashboard is empty. To add a visualization, click Add in - the menu bar. No visualizations yet? Go to the Visualize app - to create one. -

-
-
-
- - - - - You need to increase your subscription limit. Please contact - support. - - - - - - Contact support because you need to increase your subscription - limit. - - - - - - - - No data sources. Go to Management to define an index pattern. - - - - - Oops, no data sources. - - - - - - - - Delete this report? - - - - - Cancel - - - Delete - - - - - - - - - Are you sure you want to delete this report? - - - - - Cancel - - - Delete report - - - - - - - - - - Save your work before generating a report. - - - - - Please save your work before generating a report. - - - - - - - - Your session has expired. Please log in again. - - - - Please wait. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ), - }, - { - title: 'Labels', - wrapText: false, - text: ( - <> - - - - {}} - id={htmlIdGenerator()()} - label="Combine values in other bucket" - /> - - - - - - - - {}} - id={htmlIdGenerator()()} - label="Combine other" - /> - - - - - - - - - - - - Remove this index pattern? - - - - - Cancel - - - Remove index pattern - - - - - - - - Remove this index pattern? - - - - - Cancel - - - Ok - - - - - - - - ), - }, - { - title: 'Be careful with humor', - wrapText: false, - text: ( - <> - -

- Your text can be fun as long as it fits the experience—and - doesn't get in the user's way. Clever text can become - annoying when used for frequently performed tasks. Situations - where the user might lose data or otherwise be frustrated are also - not appropriate for humor. -

-
- - - - Odd, exciting, and scary trends and anomalies in your - Elasticsearch data - - - - - - No results found - - - - -

- Unfortunately, I could not find any results matching your - search. I tried really hard. I looked all over the place and - frankly, I just couldn't find anything good. Help me, - help you. -

-
-
-
- - - ), - }, - { - title: 'Verifying your text', - wrapText: false, - text: ( - <> - - - - - - - - - - - - - - - - ), - }, - ], -};