Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(documentation): Migrate Migration page #2577

Merged
merged 3 commits into from
Feb 1, 2024

Conversation

imagoiq
Copy link
Contributor

@imagoiq imagoiq commented Jan 31, 2024

How

As far as I know, there is no real way to manage state inside MDX (there is an attempt with mdx-observable, but it's alpha, not maintained and quite verbose). So I used web component (lit) without shadom DOM (aka light DOM) for that based on those examples:
https://lamplightdev.com/blog/2019/03/13/how-to-pass-data-between-web-components/
https://www.youtube.com/watch?v=T9mxtnoy9Qw
It makes sense to not use shadow dom as we want that the storybook styles apply to the content of those elements.

What was not migrated

  • Feature to copy code from <code> element.
  • Feature to store collapsible state of the accordion.

@imagoiq imagoiq self-assigned this Jan 31, 2024
@imagoiq imagoiq requested a review from gfellerph January 31, 2024 14:50
Copy link

changeset-bot bot commented Jan 31, 2024

🦋 Changeset detected

Latest commit: 144b37b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@swisspost/design-system-documentation Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@swisspost-bot
Copy link
Contributor

swisspost-bot commented Jan 31, 2024

Preview environment ready: https://preview-2577--next.design-system.post.ch
Preview environment ready: https://preview-2577--swisspost-design-system-next.netlify.app

@imagoiq imagoiq linked an issue Jan 31, 2024 that may be closed by this pull request
Copy link

sonarqubecloud bot commented Feb 1, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
2.9% Duplication on New Code

See analysis details on SonarCloud

Copy link
Member

@gfellerph gfellerph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work 🧨

@@ -12,7 +12,7 @@
"arrowParens": "avoid",
"insertPragma": false,
"proseWrap": "preserve",
"htmlWhitespaceSensitivity": "ignore",
"htmlWhitespaceSensitivity": "css",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious, why did you change this?

@imagoiq imagoiq merged commit d0cc917 into main Feb 1, 2024
9 checks passed
@imagoiq imagoiq deleted the feat/2486-docs-migration-page branch February 1, 2024 07:46
gfellerph pushed a commit that referenced this pull request Feb 7, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @swisspost/[email protected]

### Major Changes

- We are introducing the new package
`@swisspost/design-system-components-angular` 🥳, which provides a
corresponding Angular component for all our web-components. For those
working on an Angular app this means:

- Instead of the package `@swisspost/design-system-components`, which
provides native web components, the new package can be used.
- The manual creation of Angular wrapper components for our previous web
components in every project is no longer necessary.
- Full support of the standard Angular schema. The use of the
`CUSTOM_ELEMENTS_SCHEMA` schema is history.
- Component properties, events, etc. can be applied to the components in
the usual Angular way. (by
[@oliverschuerch](https://github.com/oliverschuerch) with
[#2071](#2071))

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Minor Changes

- Added icons number 2572 and 2573. (by
[@swisspost-bot](https://github.com/swisspost-bot) with
[#2553](#2553))

- Added icon number 2574. (by
[@swisspost-bot](https://github.com/swisspost-bot) with
[#2592](#2592))

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

- Set the size of the logo before it is displayed to avoid a layout jump
right after the initial rendering of the header. (by
[@alizedebray](https://github.com/alizedebray) with
[#2557](#2557))
-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

- Updated `form-control` and `form-select` sizes and added support for
floating label small size variant. (by
[@imagoiq](https://github.com/imagoiq) with
[#2396](#2396))

## @swisspost/[email protected]

### Minor Changes

- Added a documentation page for the ng-bootstrap modal component. (by
[@alizedebray](https://github.com/alizedebray) with
[#2531](#2531))

- Added a documentation page for the ng-bootstrap progressbar component.
(by [@imagoiq](https://github.com/imagoiq) with
[#2549](#2549))

- Added a documentation page for the ng-bootstrap/post
notification-overlay component. (by
[@imagoiq](https://github.com/imagoiq) with
[#2608](#2608))

- Added a documentation page for the angular `custom-select` component
based on the ng-bootstrap `dropdown` component. (by
[@b1aserlu](https://github.com/b1aserlu) with
[#2573](#2573))

- Added a documentation page for the ng-bootstrap dropdown component.
(by [@davidritter-dotcom](https://github.com/davidritter-dotcom) with
[#2551](#2551))

- Added a documentation page for the post stepper component. (by
[@alizedebray](https://github.com/alizedebray) with
[#2556](#2556))

- Added a documentation page for the design-system migration process.
(by [@imagoiq](https://github.com/imagoiq) with
[#2577](#2577))

- Added a documentation page for the ng-bootstrap typeahead component.
(by [@imagoiq](https://github.com/imagoiq) with
[#2547](#2547))

- Added a documentation page for the ng-bootstrap pagination component.
(by [@imagoiq](https://github.com/imagoiq) with
[#2549](#2549))

- Added a documentation page for the ng-bootstrap timepicker component.
(by [@imagoiq](https://github.com/imagoiq) with
[#2549](#2549))

- Added a documentation page for the post product card component. (by
[@alizedebray](https://github.com/alizedebray) with
[#2580](#2580))

- Added a getting-started docs page for the new
`@swisspost/components-angular` package. (by
[@oliverschuerch](https://github.com/oliverschuerch) with
[#2071](#2071))

- Added an alert warning that the documentation is in beta, it will
remain until all Design System components are documented. (by
[@alizedebray](https://github.com/alizedebray) with
[#2563](#2563))

### Patch Changes

- Fixed conflict between autolink anchor links and normal anchor links.
(by [@imagoiq](https://github.com/imagoiq) with
[#2529](#2529))
-   Updated dependencies:
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migration: Migration Page
3 participants