-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into 3419-component-text-highlighted
- Loading branch information
Showing
8 changed files
with
315 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@swisspost/design-system-documentation': minor | ||
| --- | ||
|
|
||
| Added documentation outlining the mission statement of the Design System. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
packages/documentation/src/stories/getting-started/mission/mission.blocks.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| interface Role { | ||
| role: string; | ||
| description: string; | ||
| } | ||
|
|
||
| interface Stakeholder { | ||
| role: string; | ||
| } | ||
|
|
||
| interface TeamMembers { | ||
| name: string; | ||
| icon: string; | ||
| } | ||
|
|
||
| export const stakeholders: Stakeholder[] = [ | ||
| { | ||
| role: 'Management', | ||
| }, | ||
| { | ||
| role: 'DevOps Team', | ||
| }, | ||
| { | ||
| role: 'Architecture', | ||
| }, | ||
| { | ||
| role: 'Project Management', | ||
| }, | ||
| { | ||
| role: 'Branding', | ||
| }, | ||
| ]; | ||
|
|
||
| export const roles: Role[] = [ | ||
| { | ||
| role: 'Web & Mobile Developers', | ||
| description: 'Utilize the system to build responsive, accessible, and consistent interfaces.', | ||
| }, | ||
| { | ||
| role: 'Digital Designers', | ||
| description: | ||
| 'Rely on standardized components to create user-friendly and cohesive experiences.', | ||
| }, | ||
| { | ||
| role: 'Digital Product Owners', | ||
| description: | ||
| 'Ensure product development aligns with Swiss Post’s design principles and standards.', | ||
| }, | ||
| ]; | ||
|
|
||
| export const teamMembers: TeamMembers[] = [ | ||
| { name: 'Development', icon: '2546' }, | ||
| { name: 'Visual Design', icon: '2591' }, | ||
| { name: 'User Experience', icon: '2336' }, | ||
| ]; |
65 changes: 65 additions & 0 deletions
65
packages/documentation/src/stories/getting-started/mission/mission.docs.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import { Meta } from '@storybook/blocks'; | ||
| import * as MissionStories from './mission.stories'; | ||
| import { roles, stakeholders, teamMembers } from './mission.blocks'; | ||
| import './mission.styles.scss'; | ||
|
|
||
| <Meta of={MissionStories} /> | ||
|
|
||
| # Swiss Post Mission | ||
|
|
||
| The Swiss Post Design System enables project teams to create seamless user experiences across all digital touchpoints by providing patterns, guidance and tools. | ||
|
|
||
| ## Who Uses the Design System? | ||
|
|
||
| <ul className="roles-list no-style-list"> | ||
| {roles.map((role, index) => ( | ||
| <li key={index} className="role-item list-item"> | ||
| <strong>{role.role}</strong> | ||
| <div className="role-description">{role.description}</div> | ||
| </li> | ||
| ))} | ||
| </ul> | ||
|
|
||
| ### The Design System is well represented and supported by our stakeholders, including: | ||
|
|
||
| <ul className="stakeholders-list no-style-list row row-cols-1 row-cols-md-3"> | ||
| {stakeholders.map((stakeholder, index) => ( | ||
| <li key={index} className="stakeholder-item list-item centered-item col"> | ||
| {stakeholder.role} | ||
| </li> | ||
| ))} | ||
| </ul> | ||
|
|
||
|
|
||
| ### Documentation | ||
|
|
||
| Entry points to the Design System are public. All documentation is written in English and uses common terminology. The documentation platforms are in sync with implementations and cross-linked. Regular updates ensure that the documentation stays aligned with the latest changes and best practices. | ||
|
|
||
| ### Core Team | ||
|
|
||
| <ul className="team-list no-style-list row"> | ||
| {teamMembers.map((teamMember, index) => ( | ||
| <li key={index} className="team-item list-item centered-item col-sm-12 col-md-4 col-lg-3 flex-lg-column"> | ||
| <post-icon name={teamMember.icon} style={{ fontSize: '3rem' }} className="team-icon"></post-icon> | ||
| {teamMember.name} | ||
| </li> | ||
| ))} | ||
| </ul> | ||
|
|
||
| These contributors are responsible for major implementations and play a central role in shaping the system. To ensure meaningful input, they have allocated time and budget to actively participate in the project, both in Figma and Web development. | ||
|
|
||
| ### Quality & Compliance | ||
|
|
||
| People are using the Design System because it has a low barrier of entry, excellent documentation, is easy to use, and improves the time to market for their product significantly. It fulfills the standards of the Web Content Accessibility Guidelines (WCAG), Level AA. | ||
|
|
||
| <div role="alert" className="alert alert-info"> | ||
| <p>Onboarding is mandatory for external agencies.</p> | ||
| </div> | ||
|
|
||
| <p className="quality-text"> | ||
| The quality of the Design System is being measured by pre-defined KPIs and is constantly improved. | ||
| </p> | ||
|
|
||
| ### Tooling | ||
|
|
||
| Design System tooling fosters collaboration between diverse disciplines and encourages contribution. It is built to provide flexibility, allowing teams to choose the platform or framework that best suits their needs. |
16 changes: 16 additions & 0 deletions
16
packages/documentation/src/stories/getting-started/mission/mission.stories.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import { MetaExtended } from '@root/types'; | ||
| import { StoryObj } from '@storybook/web-components'; | ||
|
|
||
| const meta: MetaExtended = { | ||
| id: 'b421ac9b-bac4-4e95-a909-64fdb58fc3a6', | ||
| title: 'Getting Started/Mission', | ||
| parameters: { | ||
| badges: [], | ||
| }, | ||
| }; | ||
|
|
||
| export default meta; | ||
|
|
||
| type Story = StoryObj; | ||
|
|
||
| export const Default: Story = {}; |
55 changes: 55 additions & 0 deletions
55
packages/documentation/src/stories/getting-started/mission/mission.styles.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| @use '@swisspost/design-system-styles/core.scss' as post; | ||
|
|
||
| .no-style-list { | ||
| margin: 0; | ||
| padding: 0; | ||
| list-style: none; | ||
| } | ||
|
|
||
| .roles-list { | ||
| display: grid; | ||
| grid-template-rows: repeat(3, 1fr); | ||
| justify-content: center; | ||
| } | ||
|
|
||
| .role-item { | ||
| margin-bottom: 1rem; | ||
| padding: 1rem; | ||
| border: 1px solid #ddd; | ||
| border-radius: 6px; | ||
| } | ||
|
|
||
| .stakeholders-list { | ||
| justify-content: center; | ||
| align-items: center; | ||
| } | ||
|
|
||
| .stakeholder-item { | ||
| padding: 1rem; | ||
| border: 1px solid #dee2e6; | ||
| text-align: center; | ||
| } | ||
|
|
||
| .team-list { | ||
| justify-content: center; | ||
| margin-bottom: 1rem; | ||
| } | ||
|
|
||
| .team-item { | ||
| display: flex; | ||
| justify-content: center; | ||
| border: 1px solid #dee2e6; | ||
| align-items: center; | ||
| padding: 1rem; | ||
| gap: 1rem; | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| .alert { | ||
| margin-top: 1rem; | ||
| } | ||
|
|
||
| .quality-text { | ||
| margin-top: 1rem; | ||
| text-align: left; | ||
| } |
Oops, something went wrong.