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.

Sign up for GitHub

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

Jump to bottom

feat(documentation): add docs page on how to use columns #2062

Merged
merged 13 commits into from
Nov 8, 2023
Merged

feat(documentation): add docs page on how to use columns #2062

merged 13 commits into from
Nov 8, 2023

Conversation

davidritter-dotcom
Copy link
Contributor

No description provided.

@davidritter-dotcom davidritter-dotcom linked an issue Oct 10, 2023 that may be closed by this pull request
Story: Columns #1049
Closed
@davidritter-dotcom davidritter-dotcom requested a review from a team as a code owner October 10, 2023 07:52
@changeset-bot
Copy link

changeset-bot bot commented Oct 10, 2023 •
edited
Loading

🦋 Changeset detected

Latest commit: 76c909d

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 Minor

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 Oct 10, 2023 •
edited
Loading

Preview environment ready: https://preview-2062--swisspost-design-system-next.netlify.app

@imagoiq
Copy link
Contributor

imagoiq commented Oct 10, 2023

I'm not sure what we would like to see in this page, perhaps @oliverschuerch you are better suited to review this PR?

oliverschuerch
oliverschuerch requested changes Oct 10, 2023
View reviewed changes
Copy link
Contributor

@oliverschuerch oliverschuerch left a comment

Choose a reason for hiding this comment

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

There are a lot of difficult to understand examples at the end of the doc.
I would try to simplify them by removing breakpoint infixes (e.g. remove -md- where possible).
And maybe we should remove the "Margin Utilities" example completly.

packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
oliverschuerch
oliverschuerch requested changes Oct 17, 2023
View reviewed changes
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Show resolved Hide resolved
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
packages/documentation/src/stories/foundation/layout/Columns/columns.stories.ts Outdated Show resolved Hide resolved
gfellerph
gfellerph requested changes Oct 26, 2023
View reviewed changes
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.

@davidritter-dotcom, this page looks really nice with the interactive explanations. Here are some thoughts:

  • The initial text looks very large, I fear nobody is going to read that and it pushes the interesting content below the fold. Can we shorten it?
  • The grid is based on the bootstrap grid. I think this info is important at the start, so people that already know the bootstrap one feel right at home. We should also link to the bootstrap grid docs (also on the grid page)

oliverschuerch
oliverschuerch reviewed Nov 7, 2023
View reviewed changes
Copy link
Contributor

@oliverschuerch oliverschuerch left a comment

Choose a reason for hiding this comment

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

Please add the columns page to the preview.ts order property and update the todo page.

...
order: [
  ...
  'Foundations',
  [
    ...
    'Layout',
    ['Breakpoints', 'Containers', 'Grid', 'Column', 'TODOS'],
    ...
  ],
  ...
],
...

@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Nov 8, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@davidritter-dotcom davidritter-dotcom merged commit f8967d2 into main Nov 8, 2023
9 checks passed
@davidritter-dotcom davidritter-dotcom deleted the 1049-story-columns branch November 8, 2023 08:49
@github-actions github-actions bot mentioned this pull request Nov 8, 2023
Merged
gfellerph pushed a commit that referenced this pull request Nov 10, 2023
@github-actions
chore(changesets): 🦋📦 publish packages (#2211)
596c589 
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]

### Minor Changes

- Added a link to settings in the user drop-down menu for business
users. (by [@alizedebray](https://github.com/alizedebray) with
[#2234](#2234))

### Patch Changes

- Replaced the old twitter logo with the new X logo. (by
[@b1aserlu](https://github.com/b1aserlu) with
[#2176](#2176))
-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

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

## @swisspost/[email protected]

### Patch Changes

- Added a descriptive text to the Post logo home link. (by
[@b1aserlu](https://github.com/b1aserlu) with
[#2101](#2101))
-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

- Added official way to use label in a floating-label select as a
placeholder. (by [@imagoiq](https://github.com/imagoiq) with
[#2200](#2200))

- Fixed display of button-group input when using checkbox or radio
variant. (by [@imagoiq](https://github.com/imagoiq) with
[#2133](#2133))

- Fixed offset of radio button when checked and in inline layout. (by
[@imagoiq](https://github.com/imagoiq) with
[#2065](#2065))

- The following placeholders from the `\_text.scss` file are depreacted
an will be removed in a future version: `%list-adjustment`,
`%module-container`, `%default-module-spacer`, `%text-container`. (by
[@b1aserlu](https://github.com/b1aserlu) with
[#2171](#2171))

- Fixed default icon flashing when using a `post-icon` on alerts. (by
[@imagoiq](https://github.com/imagoiq) with
[#2244](#2244))

## @swisspost/[email protected]

### Minor Changes

- Added docs page on how to use columns. (by
[@davidritter-dotcom](https://github.com/davidritter-dotcom) with
[#2062](#2062))

### Patch Changes

- Added official way to use label in a floating-label select as a
placeholder. (by [@imagoiq](https://github.com/imagoiq) with
[#2200](#2200))

- Extended the `@swisspost/design-system-components` package
getting-started docs page to show multiple ways how it can be
used/imported in different project setups. (by
[@oliverschuerch](https://github.com/oliverschuerch) with
[#2214](#2214))

-   Updated dependencies:
    -   @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]

### 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
Reviewers

@imagoiq imagoiq imagoiq approved these changes

@gfellerph gfellerph gfellerph approved these changes

@b1aserlu b1aserlu Awaiting requested review from b1aserlu

@oliverschuerch oliverschuerch Awaiting requested review from oliverschuerch

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Story: Columns
5 participants
@davidritter-dotcom @swisspost-bot @imagoiq @gfellerph @oliverschuerch