Skip to content

Commit 5a2d210

Browse files
authored
chore(docs): Update header format in migration documentation (#5187)
* chore(docs): Update header format in migration documentation * Change header from H2 to H1 in migration guide Updated header level for migration guide. * Update migration guide for version 0.4.x * Change header level in migration documentation * Revise migration guide for v0.5.x to v0.6.x Updated migration documentation for version 0.5.x to 0.6.x, including changes to icons and component properties. * Revise migration guide for version 0.7.x Updated migration documentation for version 0.6.x to 0.7.x, changing headings and clarifying path changes. * Revise migration guide for version 1.0.0 Updated migration documentation to reflect package and property renaming. * Update v1.x.x-to-v2.0.0.md * Update docs/migration/v2.x.x-to-v3.0.0.md
1 parent 431c5d0 commit 5a2d210

File tree

8 files changed

+27
-27
lines changed

8 files changed

+27
-27
lines changed

docs/migration/v0.2.x-to-v0.3.x.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Migration Beta (0.2.x) ➡ Beta (0.3.x)
1+
# Migration Beta (0.2.x) ➡ Beta (0.3.x)
22

33
We refactored our colors which might add some breaking changes to current projects: <https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system/support/migration-guides/v0-3-0>
44

docs/migration/v0.3.x-to-v0.4.x.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Migration Beta (0.3.x) ➡ Beta (0.4.x)
1+
# Migration Beta (0.3.x) ➡ Beta (0.4.x)
22

3-
### Icons
3+
## Icons
44

55
We refactored our icons which might add some breaking changes to current projects: <https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system/support/migration-guides/v0-3-0>
66

7-
#### Migration table
7+
### Migration table
88

99
| old | new |
1010
| ------------------- | ------------------------- |

docs/migration/v0.4.x-to-v0.5.x.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
## Migration Beta (0.4.x) ➡ Beta (0.5.x)
1+
# Migration Beta (0.4.x) ➡ Beta (0.5.x)
22

33
No breaking changes

docs/migration/v0.5.x-to-v0.6.x.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
## Migration Beta (0.5.x) ➡ Beta (0.6.x)
1+
# Migration Beta (0.5.x) ➡ Beta (0.6.x)
22

3-
### Icons
3+
## Icons
44

55
We removed the `.svg` icons from `@db-ux/core-foundations`. This will not affect the `woff2` files required for components. If you still need some `.svg` files you need to install [`@db-ux/core-icons`](https://www.npmjs.com/package/@db-ux/core-icons).
66

7-
### Components
7+
## Components
88

99
We changed some properties for components to align with Figma properties:
1010

11-
#### Accordion-Item
11+
### Accordion-Item
1212

1313
- `content` ➡️ `text`
1414

15-
#### Notification
15+
### Notification
1616

1717
- `behaviour="closeable|permanent"` ➡️ `closeable="true/false"`- Defaults to `false`
1818

19-
#### Form-Components (Input, Select, Checkbox, Radio, Switch, Textarea)
19+
### Form-Components (Input, Select, Checkbox, Radio, Switch, Textarea)
2020

2121
- `variant="hidden"` ➡️ `showLabel="true/false"` - Defaults to `true`
2222
- `customValidity` ➡️ `validation`

docs/migration/v0.6.x-to-v0.7.x.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Migration Beta (0.6.x) ➡ Beta (0.7.x)
1+
# Migration Beta (0.6.x) ➡ Beta (0.7.x)
22

3-
### Removed brand assets
3+
## Removed brand assets
44

55
We needed to remove the brand assets (font & icons) from our [`@db-ux/core-foundations`](https://www.npmjs.com/package/@db-ux/core-foundations) node package. Please follow the guidelines within [DB Marketingportal](https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system/resources/db-theme) on how to retrieve it either as an Inner Source package (DB internal) or to still install the node package from [npmjs.com](https://www.npmjs.com/package/@db-ux/db-theme) (DB external).
66

7-
### Path changes
7+
## Path changes
88

99
We needed to change some path, so you would probably need to make some adaptions within your code:
1010

docs/migration/v0.7.x-to-v1.0.0.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Migration Beta (0.7.x) ➡ 1.0.0
1+
# Migration Beta (0.7.x) ➡ 1.0.0
22

3-
### Packages
3+
## Packages
44

55
- `@db-ui/foundations` ➡️ `@db-ux/core-foundations`
66
- `@db-ui/components` ➡️ `@db-ux/core-components`
@@ -11,45 +11,45 @@
1111
- `@db-ui/v-components` ➡️ `@db-ux/v-core-components`
1212
- `@db-ui/web-components` ➡️ `@db-ux/wc-core-components`
1313

14-
### Foundations
14+
## Foundations
1515

1616
We update some classes and `data-`-attributes to match with the "Appearances" inside Figma:
1717

1818
- `data-color-scheme` ➡️ `data-mode` - if you set a container to a fixed `dark` or `light` mode
1919
- `data-container-color` ➡️ `data-color` - if you changed an adaptive color scheme
2020
-`data-color="XXX-bg-basic-level-[1|2|3]"` - removed combination of background and adaptive color scheme
2121

22-
### Components
22+
## Components
2323

2424
We changed some properties for components to align with Figma properties:
2525

26-
#### Global
26+
### Global
2727

2828
- Renamed all `behaviour` props to `behavior`
2929

30-
#### Accordion
30+
### Accordion
3131

3232
- `behaviour="default"` ➡️ `behavior="divider"`
3333

34-
#### Badge
34+
### Badge
3535

3636
We updated the colors for the `weak` badge to match better with `strong` and the new `origin` badge.
3737

38-
#### Card
38+
### Card
3939

4040
- `behaviour="default"` ➡️ `behavior="static"`
4141

42-
#### Tabs
42+
### Tabs
4343

4444
We updated the colors for the `weak` tag to match better with `strong` and the new `origin` tag.
4545

4646
- `behaviour` ➡️ `behavior`
4747

48-
#### Tag
48+
### Tag
4949

5050
- `behaviour` ➡️ `behavior`
5151

52-
#### Tooltip
52+
### Tooltip
5353

5454
- `variant="'with arrow'|'basic'"` ➡️ `showArrow="true|false"` - Defaults to `true`
5555

docs/migration/v1.x.x-to-v2.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Migration Beta (1.x.x) ➡ 2.0.0
1+
# Migration (1.x.x) ➡ 2.0.0
22

33
## Tag and Batch components
44

docs/migration/v2.x.x-to-v3.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Migration Beta (2.x.x) ➡ 3.0.0
1+
# Migration (2.x.x) ➡ 3.0.0
22

33
## transparent-hovered/-pressed
44

0 commit comments

Comments
 (0)