From d5aaf1dbc543079eb1955dae46938aadef09d459 Mon Sep 17 00:00:00 2001 From: TJ Egan Date: Fri, 7 Feb 2020 13:27:36 -0800 Subject: [PATCH 1/5] docs(readme): remove readmes, old migratiion docs (#5277) --- .../src/components/accordion/README.md | 32 --- .../components/accordion/migrate-to-7.x.md | 49 ---- .../src/components/breadcrumb/README.md | 40 --- .../components/breadcrumb/migrate-to-7.x.md | 22 -- .../src/components/button/README.md | 57 ---- .../src/components/button/migrate-to-7.x.md | 35 --- .../src/components/checkbox/README.md | 71 ----- .../src/components/checkbox/migrate-to-7.x.md | 26 -- .../src/components/code-snippet/README.md | 21 -- .../components/code-snippet/migrate-to-7.x.md | 23 -- .../components/code-snippet/migrate-to-9.x.md | 18 -- .../src/components/combo-box/README.md | 9 - .../src/components/content-switcher/README.md | 243 ------------------ .../content-switcher/migrate-to-7.x.md | 42 --- .../src/components/data-table/README.md | 139 ---------- .../src/components/date-picker/README.md | 107 -------- .../src/components/dropdown/README.md | 92 ------- .../src/components/dropdown/migrate-to-7.x.md | 34 --- .../src/components/file-uploader/README.md | 152 ----------- .../file-uploader/migrate-to-7.x.md | 46 ---- .../src/components/floating-menu/README.md | 32 --- .../components/src/components/form/README.md | 146 ----------- .../src/components/form/migrate-to-7.x.md | 47 ---- .../src/components/inline-loading/README.md | 56 ---- .../src/components/link/migrate-to-7.x.md | 25 -- .../src/components/list-box/README.md | 23 -- .../components/src/components/list/README.md | 11 - .../src/components/list/migrate-to-7.x.md | 21 -- .../src/components/loading/README.md | 68 ----- .../src/components/loading/migrate-to-7.x.md | 34 --- .../components/src/components/modal/README.md | 165 ------------ .../src/components/modal/migrate-to-7.x.md | 65 ----- .../src/components/multi-select/README.md | 58 ----- .../src/components/notification/README.md | 127 --------- .../components/notification/migrate-to-7.x.md | 65 ----- .../src/components/number-input/README.md | 14 - .../components/number-input/migrate-to-7.x.md | 43 ---- .../src/components/overflow-menu/README.md | 122 --------- .../overflow-menu/migrate-to-7.x.md | 45 ---- .../src/components/pagination-nav/README.md | 30 --- .../src/components/pagination/README.md | 31 --- .../components/pagination/migrate-to-7.x.md | 29 --- .../components/progress-indicator/README.md | 105 -------- .../progress-indicator/experimental.md | 139 ---------- .../progress-indicator/migrate-to-7.x.md | 46 ---- .../src/components/radio-button/README.md | 8 - .../components/radio-button/migrate-to-7.x.md | 19 -- .../components/src/components/search/FAQ.md | 24 -- .../src/components/search/README.md | 34 --- .../src/components/search/migrate-to-7.x.md | 39 --- .../src/components/select/README.md | 50 ---- .../src/components/select/migrate-to-7.x.md | 28 -- .../src/components/slider/README.md | 36 --- .../src/components/structured-list/README.md | 94 ------- .../components/src/components/tabs/README.md | 96 ------- .../src/components/tabs/migrate-to-7.x.md | 27 -- .../components/src/components/tag/README.md | 9 - .../src/components/tag/migrate-to-7.x.md | 34 --- .../src/components/text-area/README.md | 6 - .../components/text-area/migrate-to-7.x.md | 26 -- .../src/components/text-input/README.md | 33 --- .../components/text-input/migrate-to-7.x.md | 40 --- .../components/src/components/tile/README.md | 63 ----- .../src/components/time-picker/README.md | 26 -- .../src/components/toggle/README.md | 21 -- .../src/components/toggle/migrate-to-7.x.md | 23 -- .../src/components/toolbar/README.md | 33 --- .../src/components/tooltip/README.md | 182 ------------- .../src/components/tooltip/migrate-to-9.x.md | 28 -- .../src/components/ui-shell/README.md | 96 ------- 70 files changed, 3880 deletions(-) delete mode 100644 packages/components/src/components/accordion/README.md delete mode 100644 packages/components/src/components/accordion/migrate-to-7.x.md delete mode 100644 packages/components/src/components/breadcrumb/README.md delete mode 100644 packages/components/src/components/breadcrumb/migrate-to-7.x.md delete mode 100644 packages/components/src/components/button/README.md delete mode 100644 packages/components/src/components/button/migrate-to-7.x.md delete mode 100644 packages/components/src/components/checkbox/README.md delete mode 100644 packages/components/src/components/checkbox/migrate-to-7.x.md delete mode 100644 packages/components/src/components/code-snippet/README.md delete mode 100644 packages/components/src/components/code-snippet/migrate-to-7.x.md delete mode 100644 packages/components/src/components/code-snippet/migrate-to-9.x.md delete mode 100644 packages/components/src/components/combo-box/README.md delete mode 100644 packages/components/src/components/content-switcher/README.md delete mode 100644 packages/components/src/components/content-switcher/migrate-to-7.x.md delete mode 100644 packages/components/src/components/data-table/README.md delete mode 100644 packages/components/src/components/date-picker/README.md delete mode 100644 packages/components/src/components/dropdown/README.md delete mode 100644 packages/components/src/components/dropdown/migrate-to-7.x.md delete mode 100644 packages/components/src/components/file-uploader/README.md delete mode 100644 packages/components/src/components/file-uploader/migrate-to-7.x.md delete mode 100644 packages/components/src/components/floating-menu/README.md delete mode 100644 packages/components/src/components/form/README.md delete mode 100644 packages/components/src/components/form/migrate-to-7.x.md delete mode 100644 packages/components/src/components/inline-loading/README.md delete mode 100644 packages/components/src/components/link/migrate-to-7.x.md delete mode 100644 packages/components/src/components/list-box/README.md delete mode 100644 packages/components/src/components/list/README.md delete mode 100644 packages/components/src/components/list/migrate-to-7.x.md delete mode 100644 packages/components/src/components/loading/README.md delete mode 100644 packages/components/src/components/loading/migrate-to-7.x.md delete mode 100644 packages/components/src/components/modal/README.md delete mode 100644 packages/components/src/components/modal/migrate-to-7.x.md delete mode 100644 packages/components/src/components/multi-select/README.md delete mode 100644 packages/components/src/components/notification/README.md delete mode 100644 packages/components/src/components/notification/migrate-to-7.x.md delete mode 100644 packages/components/src/components/number-input/README.md delete mode 100644 packages/components/src/components/number-input/migrate-to-7.x.md delete mode 100644 packages/components/src/components/overflow-menu/README.md delete mode 100644 packages/components/src/components/overflow-menu/migrate-to-7.x.md delete mode 100644 packages/components/src/components/pagination-nav/README.md delete mode 100644 packages/components/src/components/pagination/README.md delete mode 100644 packages/components/src/components/pagination/migrate-to-7.x.md delete mode 100644 packages/components/src/components/progress-indicator/README.md delete mode 100644 packages/components/src/components/progress-indicator/experimental.md delete mode 100644 packages/components/src/components/progress-indicator/migrate-to-7.x.md delete mode 100644 packages/components/src/components/radio-button/README.md delete mode 100644 packages/components/src/components/radio-button/migrate-to-7.x.md delete mode 100644 packages/components/src/components/search/FAQ.md delete mode 100644 packages/components/src/components/search/README.md delete mode 100644 packages/components/src/components/search/migrate-to-7.x.md delete mode 100644 packages/components/src/components/select/README.md delete mode 100644 packages/components/src/components/select/migrate-to-7.x.md delete mode 100644 packages/components/src/components/slider/README.md delete mode 100644 packages/components/src/components/structured-list/README.md delete mode 100644 packages/components/src/components/tabs/README.md delete mode 100644 packages/components/src/components/tabs/migrate-to-7.x.md delete mode 100644 packages/components/src/components/tag/README.md delete mode 100644 packages/components/src/components/tag/migrate-to-7.x.md delete mode 100644 packages/components/src/components/text-area/README.md delete mode 100644 packages/components/src/components/text-area/migrate-to-7.x.md delete mode 100644 packages/components/src/components/text-input/README.md delete mode 100644 packages/components/src/components/text-input/migrate-to-7.x.md delete mode 100644 packages/components/src/components/tile/README.md delete mode 100644 packages/components/src/components/time-picker/README.md delete mode 100644 packages/components/src/components/toggle/README.md delete mode 100644 packages/components/src/components/toggle/migrate-to-7.x.md delete mode 100644 packages/components/src/components/toolbar/README.md delete mode 100644 packages/components/src/components/tooltip/README.md delete mode 100644 packages/components/src/components/tooltip/migrate-to-9.x.md delete mode 100644 packages/components/src/components/ui-shell/README.md diff --git a/packages/components/src/components/accordion/README.md b/packages/components/src/components/accordion/README.md deleted file mode 100644 index 8c215c12a244..000000000000 --- a/packages/components/src/components/accordion/README.md +++ /dev/null @@ -1,32 +0,0 @@ -### SCSS - -#### Modifiers - -Use these modifiers with `.bx--accordion` class. - -| Default Selector | Description | -| ------------------------------ | ------------------------------------------ | -| `.bx--accordion__item--active` | The className for an active accordion item | - -### JavaScript - -#### Public Methods - -| Name | Params | Description | -| --------- | ------ | -------------------- | -| `release` | | Deletes the instance | - -#### Options - -| Option | Default Selector | Description | -| -------------------------- | ----------------------------- | ------------------------------------------------- | -| `selectorInit` | `[data-accordion]` | The selector to find the accordion | -| `selectorAccordionItem` | `[data-accordion-item]` | The selector to find the accordion item component | -| `selectorAccordionContent` | `.bx--accordion__content` | The selector for the accordion content element | -| `classActive` | `bx--accordion__item--active` | The className for an active accordion item | - -#### Classes - -| Name | Description | -| ----------------------------- | ------------------------------------------ | -| `bx--accordion__item--active` | The className for an active accordion item | diff --git a/packages/components/src/components/accordion/migrate-to-7.x.md b/packages/components/src/components/accordion/migrate-to-7.x.md deleted file mode 100644 index df8e5d4f5ba4..000000000000 --- a/packages/components/src/components/accordion/migrate-to-7.x.md +++ /dev/null @@ -1,49 +0,0 @@ -### HTML - -Updating HTML pertains mainly to SVG icon paths. It's now recommended to use -inline SVG icons. - -```html - - - -``` - -But if you're going to make use of carbon-icons.svg, it's recommended to use the -sprite svg file locally in your project. - -Update `` to a local path of bluemix-icons.svg, which should -look something like this: - -```html - - - -``` - -For more details on installing and using bluemix-icons, see install and usage -guidelines docs here. - -### SCSS - -The `_accordion.scss` file is now located at -`src/components/accordion/_accordion.scss`. You'll need to update any `@import` -statements for this file to reflect this change. - -**New**: - -```scss -@import 'path_to_node_modules/carbon-components/src/components/accordion/accordion'; -``` - -**Old**: - -```scss -@import 'path_to_node_modules/@console/bluemix-components/src/components/accordion/accordion'; -``` diff --git a/packages/components/src/components/breadcrumb/README.md b/packages/components/src/components/breadcrumb/README.md deleted file mode 100644 index 26c518c5e1b3..000000000000 --- a/packages/components/src/components/breadcrumb/README.md +++ /dev/null @@ -1,40 +0,0 @@ -### SCSS - -| Selector | Description | -| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -| `bx--breadcrumb` | Used on the containing `