docs: [BLA-816] updated documentation and readme files with domain ch…

…ange
otto-de · Jun 14, 2024 · 9ed5af0 · 9ed5af0
1 parent 23d48ee
commit 9ed5af0
Show file tree

Hide file tree

Showing 19 changed files with 158 additions and 41 deletions.
diff --git a/DOCKER-README.md b/DOCKER-README.md
@@ -7,7 +7,7 @@ The goal of the B2B Design System is to provide frontend components that encapsu
 
 This image packs the distribution files and main documentation, and can be deployed in any server and run as a static site.
 
-You can find our documentation released in [this link](https://internal.otto.market/design-system/?path=/story/overview--page), and the Design System repository [here](https://github.com/otto-de/b2b-design-system).
+You can find our documentation released in [this link](https://b2b-design-system.otto.market/?path=/docs/overview--docs), and the Design System repository [here](https://github.com/otto-de/b2b-design-system).
 
 ## Usage
 

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ for teams to use out of the box.
 We wish to support different frontend frameworks and for this goal we are building this solution using [Web 
 Components](https://www.webcomponents.org/) with [Stencil](https://stenciljs.com/docs/introduction).
 
-You can find our documentation in [this link](https://internal.otto.market/design-system/?path=/story/overview--page).
+You can find our documentation in [this link](https://b2b-design-system.otto.market/?path=/docs/overview--docs).
 
 ### Why open source?
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/core-components/README.md b/packages/core-components/README.md
@@ -5,4 +5,4 @@ This is the core components package for the B2B Design System. You can use nativ
 js` applications. 
 
 For information on how to get started in `vue`, you can follow
-our [documentation page](https://internal.otto.market/design-system/?path=/story/getting-started-vue--page).
+our [documentation page](https://b2b-design-system.otto.market/?path=/docs/getting-started-vue--docs).
diff --git a/packages/core-components/scripts/stencil/generate-vue-web-types.ts b/packages/core-components/scripts/stencil/generate-vue-web-types.ts
@@ -26,7 +26,7 @@ const generateVueWebTypes = (docsData: JsonDocs) => {
     const slots = [];
     const events = [];
     const docUrl =
-      'https://internal.otto.market/design-system/?path=/story/overview--page';
+      'https://b2b-design-system.otto.market/?path=/docs/overview--docs';
 
     component.props.map((prop: JsonDocsProp) => {
       const name = prop.attr || prop.name;

diff --git a/packages/core-components/src/docs/getting-started/10-overview.mdx b/packages/core-components/src/docs/getting-started/10-overview.mdx
@@ -1,10 +1,17 @@
 import { Canvas, Meta, Story, Markdown } from '@storybook/addon-docs';
 
-<Meta title="Overview" />
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
 
 <br />
 <br />
 
+<Meta title="Overview" />
+
 # B2B DESIGN SYSTEM
 
 The goal of the [B2B Design System](https://github.com/otto-de/b2b-design-system) is to provide frontend components that encapsulate styles and behaviour for teams
@@ -25,7 +32,7 @@ individual HTML elements that is [already highly compatible](https://custom-elem
 
 Patterns are recurring building blocks and components in the frontend that are provided centrally with the goal of
 ensuring visual and functional consistency. Patterns can be provided at different levels: local patterns
-are developed by an OPC module team – global patterns are developed by the B2B-Neptune team and made available to all
+are developed by an OPC module team – global patterns are developed by the BlaBlaFish team and made available to all
 OPC module teams.
 
 <br />
@@ -36,9 +43,9 @@ Currently, we support Vue 2, 3 and React.
 
 If you would like to start right away, choose your framework and follow the guides.
 
-[Getting started with React](?path=/docs/getting-started-react--page)
+[Getting started with React](?path=/docs/getting-started-react--docs)
 
-[Getting started with Vue](?path=/docs/getting-started-vue--page)
+[Getting started with Vue](?path=/docs/getting-started-vue--docs)
 
 <br />
 
@@ -51,7 +58,7 @@ You can find an overview of current and previous versions [here](https://github.
 
 ## Contribution
 
-If you are a developer from the Deep Sea and want to contribute to the Design System, please refer to [this guide](?path=/story/guidelines-contribution--page)
+If you are a developer from the Deep Sea and want to contribute to the Design System, please refer to [this guide](?path=/docs/guidelines-contribution--docs)
 how to set up and run our project on your machine.
 
-To request a new pattern or component, please contact the B2B Design System team, we will guide you from there.
+To request a new pattern or component, please contact the BlaBlaFish team, we will guide you from there.
diff --git a/packages/core-components/src/docs/getting-started/15-updates.mdx b/packages/core-components/src/docs/getting-started/15-updates.mdx
@@ -1,6 +1,16 @@
 import { Canvas, Meta, Story, Markdown } from '@storybook/addon-docs';
 import Changelog from './CHANGELOG.md?raw';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Updates" />
 
 # Updates

diff --git a/packages/core-components/src/docs/getting-started/20-react-installation-guide.mdx b/packages/core-components/src/docs/getting-started/20-react-installation-guide.mdx
@@ -1,5 +1,15 @@
 import { Meta } from '@storybook/addon-docs';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Getting Started/React" />
 
 # React Installation and usage
@@ -17,10 +27,10 @@ To use the components, you need to load a CSS file and some JavaScript. The CSS
 ```html
 <link
   rel="stylesheet"
-  href="https://internal.otto.market/design-system/dist/b2b-core-components/b2b-core-components.css" />
+  href="https://b2b-design-system.otto.market/dist/b2b-core-components/b2b-core-components.css" />
 <script
   type="module"
-  src="https://internal.otto.market/design-system/dist/b2b-core-components/b2b-core-components.esm.js"></script>
+  src="https://b2b-design-system.otto.market/dist/b2b-core-components/b2b-core-components.esm.js"></script>
 ```
 
 ## With a bundler or ES modules

diff --git a/packages/core-components/src/docs/getting-started/30-vue-getting-started.mdx b/packages/core-components/src/docs/getting-started/30-vue-getting-started.mdx
@@ -1,17 +1,27 @@
 import { Meta, Source } from '@storybook/addon-docs';
 import dedent from 'ts-dedent';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Getting Started/Vue" />
 
 # Vue Support
 
 Our web components are supported by vue out of the box.
 In this guide you can find:
 
-- [Vue Installation and usage](#vue-installation-and-usage)
-- [How to use b2b-core-components in Vue 3](#how-to-use-b2b-core-components-in-vue-3)
-- [How to use b2b-core-components in Vue 2](#how-to-use-b2b-core-components-in-vue-2)
-- [How to use b2b-core-components in Nuxt 2](#how-to-use-b2b-core-components-in-nuxt-2)
+- [Vue Installation and usage](#installation-and-usage)
+- [How to use b2b-core-components in Vue 3](#vue-3)
+- [How to use b2b-core-components in Vue 2](#vue-2)
+- [How to use b2b-core-components in Nuxt 2](#nuxt-2)
 - [About Web Components 'slots'](#about-web-components-slots)
 - [V-Model Support](#v-model-support)
 

diff --git a/packages/core-components/src/docs/getting-started/40-SSR-guide.mdx b/packages/core-components/src/docs/getting-started/40-SSR-guide.mdx
@@ -1,13 +1,23 @@
 import { Meta } from '@storybook/addon-docs';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Getting Started/SSR" />
 
 # Server Side Rendering (SSR)
 
 So far we have tested this builds with [Next.js](https://nextjs.org/) and [Nuxt.js](https://nuxtjs.org/). If you are
 using another SSR framework let us know if you are experiencing any issues.
 
-For details on how to use with `Nuxt.js`, please follow [these instructions](?path=/docs/getting-started-vue--page#how-to-use-b2b-core-components-in-nuxt-2).
+For details on how to use with `Nuxt.js`, please follow [these instructions](?path=/docs/getting-started-vue--docs#nuxt-2).
 
 <br />
 

diff --git a/packages/core-components/src/docs/getting-started/50-CDN-installation.mdx b/packages/core-components/src/docs/getting-started/50-CDN-installation.mdx
@@ -1,5 +1,15 @@
 import { Meta } from '@storybook/addon-docs';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Getting Started/CDN installation" />
 
 # How to install B2B Components from CDN
@@ -13,8 +23,8 @@ not the whole library.
 ```html
 <link
   rel="stylesheet"
-  href="https://internal.otto.market/design-system/dist/b2b-core-components/b2b-core-components.css" />
+  href="https://b2b-design-system.otto.market/dist/b2b-core-components/b2b-core-components.css" />
 <script
   type="module"
-  src="https://internal.otto.market/design-system/dist/b2b-core-components/b2b-core-components.esm.js"></script>
+  src="https://b2b-design-system.otto.market/dist/b2b-core-components/b2b-core-components.esm.js"></script>
 ```
diff --git a/...e-components/src/docs/getting-started/50-github-packages-installation-guide.mdx b/...e-components/src/docs/getting-started/50-github-packages-installation-guide.mdx
@@ -1,5 +1,15 @@
 import { Meta } from '@storybook/addon-docs';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Getting Started/Package Installation" />
 
 # Package Installation
@@ -18,9 +28,9 @@ import '@otto-de/b2b-core-components/dist/b2b-core-components/b2b-core-component
 
 For a more detailed guide of installation and usage please follow one of our framework guidelines:
 
-[Getting started with React](?path=/docs/getting-started-react--page)
+[Getting started with React](?path=/docs/getting-started-react--docs)
 
-[Getting started with Vue](?path=/docs/getting-started-vue--page)
+[Getting started with Vue](?path=/docs/getting-started-vue--docs)
 
 ---
 

diff --git a/packages/core-components/src/docs/getting-started/60-design-tokens.mdx b/packages/core-components/src/docs/getting-started/60-design-tokens.mdx
@@ -1,6 +1,16 @@
 import { Meta } from '@storybook/addon-docs';
 import LinkTo from '@storybook/addon-links/react';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Getting Started/Design Tokens Installation" />
 
 # B2B Design Tokens
@@ -24,7 +34,7 @@ npm install @otto-de/b2b-tokens
 ```
 
 _\*This is currently hosted in GitHub packages withing the Otto organisation, therefore it requires an authentication
-token to be able to install. Follow [this guide](?path=/story/getting-started-package-installation--page)
+token to be able to install. Follow [this guide](?path=/docs/getting-started-package-installation--docs)
 if you haven't configured this yet._
 
 ### 2. SCSS usage
@@ -41,14 +51,14 @@ You can import the css variables directly from the node package with the `@impor
 
 ## CDN
 
-You can find our tokens in this CDN `https://internal.otto.market/design-system/dist/b2b-core-components/b2b-core-components.css`
+You can find our tokens in this CDN `https://b2b-design-system.otto.market/dist/b2b-core-components/b2b-core-components.css`
 Importing them in your index headline will globally define them.
 
 ```html
 <head>
   <link
     rel="stylesheet"
     type="text/css"
-    href="https://internal.otto.market/design-system/dist/b2b-core-components/b2b-core-components.css" />
+    href="https://b2b-design-system.otto.market/dist/b2b-core-components/b2b-core-components.css" />
 </head>
 ```
diff --git a/packages/core-components/src/docs/getting-started/70-IDE-support.mdx b/packages/core-components/src/docs/getting-started/70-IDE-support.mdx
@@ -1,5 +1,15 @@
 import { Meta } from '@storybook/addon-docs';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Getting Started/IDE Support" />
 
 # IDE Support

diff --git a/packages/core-components/src/docs/guidelines/10_forms.mdx b/packages/core-components/src/docs/guidelines/10_forms.mdx
@@ -1,6 +1,16 @@
 import { Meta, Source, Canvas, Story } from '@storybook/addon-docs';
 import dedent from 'ts-dedent';
 
+<b2b-alert type='warning' opened='true' size='large' has-close-button='false'>
+The documentation and resources, including icons, JS, and CSS files, <strong>will no longer be available</strong> at https://design-system.live.b2b.platform.otto.de, https://portal.otto.market and https://internal.otto.market <strong>after 3 months</strong>.
+
+The updated [documentation](https://b2b-design-system.otto.market) and resources are now hosted at https://b2b-design-system.otto.market.
+Please refer to the new documentation and update your packages to the latest version to prevent any issues.
+</b2b-alert>
+
+<br />
+<br />
+
 <Meta title="Guidelines/Form Usage" />
 
 # Using B2B Form Components
@@ -29,7 +39,7 @@ specifically.
 
 ☝️ We support Vue `v-model` for `b2b-input`, `b2b-checkbox`, `b2b-radio`, `b2b-textarea` and `b2b-input-list` components. You can
 find more in [this
-guide](?path=/docs/getting-started-vue--page#v-model-support).
+guide](?path=/docs/getting-started-vue--docs#v-model-support).
 
 <br />