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

docs(docs): 📝 update about information #637

Merged
merged 100 commits into from
Jun 22, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
100 commits
Select commit Hold shift + click to select a range
af50bdc
docs(docs): :memo: update about information
dylankelly Jun 14, 2023
cb28eaf
Update file.md
jodwyerdpc Jun 16, 2023
bf28d33
Update form-alert.md
jodwyerdpc Jun 16, 2023
7ee8210
Update form.md
jodwyerdpc Jun 16, 2023
e592593
Update in-page-navigation.md
jodwyerdpc Jun 16, 2023
44768d8
Update key-dates.md
jodwyerdpc Jun 16, 2023
4c06a13
Update key-dates.md
jodwyerdpc Jun 16, 2023
b9a4532
Update key-dates.md
jodwyerdpc Jun 16, 2023
1149077
Update media-fullscreen.md
jodwyerdpc Jun 16, 2023
466bf7d
Update option-button.md
jodwyerdpc Jun 16, 2023
c1b9446
Update pagination.md
jodwyerdpc Jun 16, 2023
a3fd62e
Update profile.md
jodwyerdpc Jun 16, 2023
6490198
Update profile.md
jodwyerdpc Jun 16, 2023
da51f64
Update related-links.md
jodwyerdpc Jun 16, 2023
4f0e2dd
Update search-bar.md
jodwyerdpc Jun 16, 2023
7bb992b
Update search-bar.md
jodwyerdpc Jun 16, 2023
e96d1ca
Update social-share.md
jodwyerdpc Jun 16, 2023
8f194bf
Update checkbox page for docs site consistency review.md
katfay Jun 18, 2023
1f44c36
Updated checkbox page - fixed typo and spacing.md
katfay Jun 18, 2023
4d390b3
Update contact-us page for docs consistency r/v.md
katfay Jun 18, 2023
4892220
Update detail-list page for docs consistency r/v.md
katfay Jun 18, 2023
b5f780f
Fixed typos carried over from Kat's markup.md
katfay Jun 18, 2023
7a11911
Update footer page for docs consistency r/v.md
katfay Jun 18, 2023
1bb0265
Update header page for docs consistency r/v.md
katfay Jun 18, 2023
b115cf6
Update statistics-grid page for docs consistency r/v.md
katfay Jun 18, 2023
2a7e29a
Update skip-link page for docs consistency r/v.md
katfay Jun 18, 2023
fd421a6
Update results-listing page for docs consistency r/v.md
katfay Jun 18, 2023
3d75b0c
Update radio-button page for docs consistency r/v.md
katfay Jun 19, 2023
d0ed729
docs(docs): :memo: update about information
dylankelly Jun 14, 2023
a3cda9c
Update primary-navigation page for docs consistency r/v.md
katfay Jun 19, 2023
1a4a267
Update page-action page for docs consistency r/v.md
katfay Jun 19, 2023
4c0da03
Update media page for docs consistency r/v.md
katfay Jun 19, 2023
0a7dd99
Update media-gallery page for docs consistency r/v.md
katfay Jun 19, 2023
e3fe74f
Update media-embed page for docs consistency r/v.md
katfay Jun 19, 2023
b75b20b
Reinserted media fullscreen link per QA advice
katfay Jun 19, 2023
e3eac56
Update input-field page for docs consistency r/v.md
katfay Jun 19, 2023
c4d8857
Update table.md
jodwyerdpc Jun 19, 2023
5160864
Update tabs page for docs consistency r/v.md
katfay Jun 19, 2023
38fda9f
Update tag page for docs consistency r/v.md
katfay Jun 19, 2023
d2e550c
Update text-area.md
jodwyerdpc Jun 19, 2023
bb68407
Update timeline.md
jodwyerdpc Jun 19, 2023
13832dd
Update vertical-navigation.md
jodwyerdpc Jun 19, 2023
097784c
Update vertical-navigation.md
jodwyerdpc Jun 19, 2023
19595f2
Update timeline.md
jodwyerdpc Jun 19, 2023
554c06c
docs(docs): :memo: developer docs updates
dylankelly Jun 19, 2023
fdcc037
Merge remote-tracking branch 'origin/feature/docs-marketing-copy' int…
dylankelly Jun 19, 2023
cee57d1
Update accordion.md
jodwyerdpc Jun 19, 2023
1376374
docs(docs): update usage to include webcomponents info
dylankelly Jun 19, 2023
03669e9
Update alert.md
jodwyerdpc Jun 20, 2023
ada479b
Merge branch 'develop' into docs-markdown-migration
jeffdowdle Jun 20, 2023
456b0df
Merge branch 'develop' into docs-markdown-migration
jeffdowdle Jun 20, 2023
30a2276
Merge branch 'develop' into feature/docs-marketing-copy
jeffdowdle Jun 20, 2023
89b86b4
Update social-share.md
jodwyerdpc Jun 20, 2023
c8d909c
Update table.md
jodwyerdpc Jun 20, 2023
d205593
Update text-area.md
jodwyerdpc Jun 20, 2023
f2e5aa2
Update timeline.md
jodwyerdpc Jun 20, 2023
dbba12c
Update vertical-navigation.md
jodwyerdpc Jun 20, 2023
4dee3bf
Update vertical-navigation.md
jodwyerdpc Jun 20, 2023
2b6df52
Update alert.md
jodwyerdpc Jun 20, 2023
91f1410
Update accordion.md
jodwyerdpc Jun 20, 2023
ad21c8e
Update accordion.md
jodwyerdpc Jun 20, 2023
2991b31
Update category-grid.md
jodwyerdpc Jun 20, 2023
3ed3c68
Update dropdown.md
jodwyerdpc Jun 20, 2023
1499c21
Update file.md
jodwyerdpc Jun 20, 2023
1aa208f
Update footer.md
jodwyerdpc Jun 20, 2023
934ddd0
Update form.md
jodwyerdpc Jun 20, 2023
8e054b1
Update form.md
jodwyerdpc Jun 20, 2023
03612ed
Update in-page-navigation.md
jodwyerdpc Jun 20, 2023
621472b
Update media-embed.md
jodwyerdpc Jun 20, 2023
d20c8ef
Update media-fullscreen.md
jodwyerdpc Jun 20, 2023
3411466
Update page-action.md
jodwyerdpc Jun 20, 2023
7419631
Update pagination.md
jodwyerdpc Jun 20, 2023
b043b16
Update pagination.md
jodwyerdpc Jun 20, 2023
cbb2a31
Update profile.md
jodwyerdpc Jun 20, 2023
3753dbd
Delete filter-lockup.md
jodwyerdpc Jun 20, 2023
d628f5c
Create 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
7ab1c63
docs: add basic guide for creating layers
Jun 20, 2023
02ced40
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
4512466
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
d56aaba
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
e3a19a3
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
450ac2a
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
c9db561
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
711edc4
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
a7bf8b3
docs: remove localhost
Jun 20, 2023
16fd25e
docs(docs): more docs updates
dylankelly Jun 20, 2023
db9cf8e
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
4c126bb
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 20, 2023
3aaa542
Merge pull request #662 from dpc-sdp/feature/docs-creating-layers
dylankelly Jun 21, 2023
f4df4f8
Update 4.theming-guidance-for-designers.md
jodwyerdpc Jun 21, 2023
7548670
Merge branch 'docs-markdown-migration' into feature/docs-marketing-copy
jeffdowdle Jun 21, 2023
f348e1b
docs(docs): change theme spelling and enable framework docs
dylankelly Jun 21, 2023
cbc3a2b
fix(@dpc-sdp/nuxt-ripple-cli): remove spaces to appease eslint
Jun 20, 2023
ee4ab8f
chore(release): publish v2.1.0-alpha.199 [skip ci]
sdpdeploy Jun 20, 2023
45e6362
docs(docs): updated all theming guide links
jeffdowdle Jun 20, 2023
672e693
feat(@dpc-sdp/ripple-tide-api): cleanup warnings on server build
Jun 19, 2023
4a80375
chore(release): publish v2.1.0-alpha.200 [skip ci]
sdpdeploy Jun 21, 2023
a797f7b
Merge remote-tracking branch 'origin' into feature/docs-marketing-copy
dylankelly Jun 22, 2023
7806fbd
Merge branch 'develop' into feature/docs-marketing-copy
dylankelly Jun 22, 2023
a2190d3
chore(docs): hide framework
dylankelly Jun 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"editorconfig.editorconfig",
"stylelint.vscode-stylelint",
"alexkrechik.cucumberautocomplete",
"circleci.circleci"
"circleci.circleci",
"nuxt.mdc"
]
}
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@
"cSpell.words": [
"colour",
"composables",
"customisation",
"customising",
"familiarise",
"formkit",
"jsonapi",
"maxlength",
Expand Down
2 changes: 1 addition & 1 deletion docs/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default defineAppConfig({
neutralFooter: false
},
framework: {
title: 'Ripple Layer Development Guide',
title: 'Ripple Framework',
color: 'var(--rpl-clr-dark)',
neutralFooter: true
}
Expand Down
14 changes: 14 additions & 0 deletions docs/components/content/DocsIcon.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<script setup lang="ts">
interface Props {
name: string
size?: 'xs' | 's' | 'm' | 'l'
}

const props = withDefaults(defineProps<Props>(), {
size: 'xs'
})
</script>

<template>
<RplIcon :name="name" colour="default" :size="size" />
</template>
31 changes: 18 additions & 13 deletions docs/content/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ icon: carbon:home
layout: home
primaryCTA:
title: For Designers
description: Paragraph Default. Cards contain actionable content about a single topic. These are usually grouped as similar style sets.
description: Information for designers using Ripple to create brand Victoria compliant digital experiences.
image:
src: /assets/img/for-designers.png
url: /design-system/design/getting-started
secondaryCTA:
title: For Developers
description: Paragraph Default. Cards contain actionable content about a single topic. These are usually grouped as similar style sets.
description: How to get started implementing Ripple UI components in digital products.
image:
src: /assets/img/for-developers.png
url: /design-system/develop/getting-started
Expand All @@ -20,25 +20,30 @@ modulesCTA:
description: Paragraph Default. Cards contain actionable content about a single topic. These are usually grouped as similar style sets.
url: /framework
quickLink1:
title: Who should use it
description: Paragraph Default. Cards contain actionable content about a single topic. These are usually grouped as similar style sets.
url: /
title: About Ripple
description: Ripple is a system of reusable styles, components, patterns and tools for creating Victorian government digital experiences.
url: /design-system/about/what-is-ripple
quickLink2:
title: How it works
description: Paragraph Default. Cards contain actionable content about a single topic. These are usually grouped as similar style sets.
url: /
title: Who should use it
description: Ripple is built by government for government to deliver services Victorians trust and rely on.
url: /design-system/about/whos-it-for
quickLink3:
title: Getting help
description: Paragraph Default. Cards contain actionable content about a single topic. These are usually grouped as similar style sets.
url: /
title: Design principles
description: The guiding principles that are the foundation of the Ripple Design System.
url: /design-system/design/our-design-principles

framework:
title: Ripple framework
description: Ripple framework contains the tools for building SDP sites using Ripple design system components.
url: /framework
# whatsNew:
# title: What's new
# description: Ripple release information text
# links:
# -
# text: 'This link goes somewhere'
# text: 'Ripple 2.0 changelog'
# url: '#first'
# -
# text: 'As does this one'
# text: 'Ripple 2.0 Figma changelog'
# url: '#second'
---
65 changes: 62 additions & 3 deletions docs/content/design-system/1.about/1.what-is-ripple.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,66 @@
---
title: What is ripple
description: Page description
title: About Ripple
description: The design system for brand Victoria digital products
layout: page
---

## Content goes here
Ripple is a system of reusable styles, components, patterns and tools for building brand Victoria digital products.

Developed by the Single Digital Presence (SDP) team within the Department of Government Services,
Ripple strives to:

- make it easier for citizens to find, understand and use government information
- ensure users can easily navigate sites regardless of technical ability, location or device
- allow designers and developers to create consistent Brand Victoria digital products
- increase the speed of delivery for digital products and services

Over 50 government websites use Ripple to date, including our main vic.gov.au platform. These sites attract the visitation of millions of views per month.


![Screenshots of websites using SDP, vic.gov.au, police.vic.gov.au, health.vic.gov.au, legislation.vic.gov.au](/assets/img/sites.png){.docs-center-img}


## Why use Ripple?

### We solve the hard problems so you don’t have to

We have spent the past 5 years refining Ripple based on user feedback to ensure it...

- meets the publishing needs of government users, and
- makes it easier for citizens to interact with government services

Ripple users can be confident their site meets the highest industry standards and best practices for:

- accessibility
- SEO
- security
- performance

### Promotes efficiency and reuse across government

Ripple promotes efficiency and reuse by providing reusable styles, components and patterns.

It provides a set of standards to manage design at scale, to...

- reduce redundancy
- create a shared language
- provide visual consistency

Developer contributions can be shared across projects, adding value to all government departments. This results in reduced project development time and expense.

### By government, for government

The Ripple design system has been made open source by to foster collaboration across government. By making the system open source, departments and agencies can help improve the citizen experience across government. Ripple has been developed by government, for government and retains all intellectual property and expertise.


## Who can use Ripple?

Ripple is open to all departments or agencies that use Victorian Government branding.

See [Who's it for](2.whos-it-for.md) for more information on who Ripple is for.

## How do I find out more?

If you are a Victorian Government department or agency wanting to use Ripple in a brand Victoria digital product (or a vendor supporting them), please visit [https://www.vic.gov.au/work-sdp](https://www.vic.gov.au/work-sdp) or contact digital@dpc.vic.gov.au

To find out more about the Single Digital Presence program please see [https://www.vic.gov.au/single-digital-presence](https://www.vic.gov.au/single-digital-presence).
13 changes: 13 additions & 0 deletions docs/content/design-system/1.about/2.whos-it-for.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Who's it for?
description: Built by government for government.
layout: page
---

Ripple is built to help deliver websites to deliver government information to Victorian citizens. It is primarily used by Victorian government departments and agencies through the [SDP program](https://www.vic.gov.au/single-digital-presence).

Ripple is designed to make it easy to communicate government information in a clear, concise and accessible manner for all Victorians. It is solely used to represent the Victorian government brand in digital products and services.

> Ripple is intended for Victorian government branded products only, and should only be used to produce approved Victorian government branded communications.

As the system is intended to be modular, it is possible to opt into various parts of the system. For example projects not on SDP can adopt the design into their own digital products, either by building their own components, referencing our styles or importing our components. See the [Usage page](../3.develop/3.usage.md) for more information. If you are site using or wanting to use Ripple in a non SDP project please get in [touch with us](3.getting-support.md) to see how we can support your project.
26 changes: 26 additions & 0 deletions docs/content/design-system/1.about/3.getting-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Support
description: How to get help
layout: page
---


The [Ripple design system](https://www.vic.gov.au/ripple-design-system) is maintained by the [Single Digital Presence (SDP)](https://www.vic.gov.au/single-digital-presence) team at the Victorian Department of Government Services.

You can reach out to us via the following channels:

### For technical and project support

- join the discussion on [GitHub](https://github.com/dpc-sdp/ripple-framework/discussions)
- log a request through our [helpdesk](https://digital-vic.atlassian.net/servicedesk/customer/portals)
- sign up to the [SDP Slack](vic-sdp.slack.com) (Open to projects with an MoU for application support)

## Design enquiries

Email: design@dpc.vic.gov.au

## General enquiries

Email: digital@dpc.vic.gov.au


This file was deleted.

8 changes: 0 additions & 8 deletions docs/content/design-system/1.about/4.get-support/2.faq.md

This file was deleted.

This file was deleted.

8 changes: 0 additions & 8 deletions docs/content/design-system/1.about/4.get-support/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/design-system/2.design/1.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description:
layout: page
---

Ripple is the design system for the Victorian Government’s digital products. The Ripple Design System makes websites and other digital products look and feel like part of the vic.gov.au brand.
Ripple is the design system for Victorian Government digital products. The Ripple Design System makes websites and other digital products look and feel like part of the vic.gov.au brand.

The Ripple Design System creates an accessible and consistent visual user interface across all our digital products. This helps citizens trust they are visiting an official source of Victorian Government information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Ripple Design System uses these principles when making design decisions.

### Inclusive.

- A11y is top priority
- Accessibility is top priority
- Collaborative in design
- Transparent documentation
- Friendly, helpful and trustworthy
Expand Down
2 changes: 1 addition & 1 deletion docs/content/design-system/2.design/3.design-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ Design tokens prevent or reduce the need to find and replace thousands of instan

## For developers

Design tokens in Ripple are implemented as CSS variables. E.g. `--rpl-clr-primary: #0052C2`. Theming is achieved by overriding or adjusting the value of these CSS variables.
For information for developers using tokens to theme Ripple components see the [themeing guide](../3.develop/2.theming.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: Theme and brand application
description: Design tokens store our design decisions in the Ripple Design System. They are the single source of truth.
layout: page
label: Core

---

Ripple has been designed with in-built custom theming capabilities. Theming can be applied if your site requires department or entity branding and has been approved to use theming. Please note it is recommend you utilise the brand equity of vic.gov where possible and only theme your site if needed and approved. Please contact the SDP team for more information on approvals for theming.

Ripple uses primary and accent colours, an optional gradient, a link colour and a focus state colour. You can read more about their roles and uses in the colour documentation.

When theming your site, styles and components will re-theme automatically. This has been done through the use of design tokens. Design tokens represent repeated design decisions that make up a design system's visual style. Tokens replace static values, such as hex codes for colour. The token informs how colour is used and inherited to ensure a consistent and accessible user experience.

We’ve designed a colour testing process to ensure the selected colours will pass the accessibility contrast ratios. By classifying the selected colours into ‘Light’ or ‘Dark’ category. The colour system will automatically provide accessible colour contrast to ensure legibility of all content. You will not need to check if you meet WCAG requirements as we have done this for you.

To learn more about if your site should be themed, please contact the SDP team.

---

## Create a custom theme

Ripple has been designed with a primary and accent colour, this informs the colour framework.

A link colour, focus colour and optional gradient are also required when theming.

The primary, accent and focus colours can be either light or dark:

- ‘Light’ means the colour is WCAG 2.1 AA compliant with dark type (rpl-clr-dark / #1A1A1A)
- ‘Dark’ means the colour is WCAG 2.1 AA compliant with light type (rpl-clr-light / #FFFFFF)

To classify your colour as light or dark, we recommend the use [WebAim Colour Contrast Checker](https://webaim.org/resources/contrastchecker/) or the Figma plugin, [A11y - Colour Contrast Checker](https://www.figma.com/community/plugin/733159460536249875) to see if the colour is accessible with the Ripple dark or light type colours listed above.“

Classifying colours as either ‘dark’ or ‘light’ informs the implementation of other colour tokens to guarantee WCAG 2.1 AA colour contrast requirements.

It is recommended that the primary colour is always visually darker than the accent and is visually different at glance. This will ensure your users are quickly and easily directed to the most important areas of a web page.

Guidance for creating your own theme can be found on the Theming page of the Ripple 2.0 Design System Figma file.

If you don’t have access, you can request access to view the Ripple 2.0 Design System.

---

## Component specific theming

The Ripple Design System has components that allow for specific theming. This is optional, and if not used, components will adopt the default framework styling. Component specific theming is defined at a site level, and will affect all instances of the component.

There are two options for component specific styling:

- Neutral
- Custom

### Neutral

'Neutral' can be applied to the following components:

- Buttons
- Header (Reverse + Image variants only)
- Footer

The colour of neutral component variants cannot be changed. Neutral components have predefined neutral styling and cannot be edited or customised.


### Custom

'Custom' component theming can only be applied to the Footer.

The Footer has been created with component specific design tokens. It is recommended custom theming is only done if required.

To learn more about custom styling please see the Theming page of the Ripple 2.0 Design System Figma file.


## Theme Accessibility

Loading