Skip to content

Commit 6c872d3

Browse files
authored
Automate component version badges (#2656)
1 parent e24166f commit 6c872d3

File tree

53 files changed

+874
-259
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+874
-259
lines changed

website/docs/components/accordion/index.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
11
---
22
title: Accordion
3-
description: An accordion is a vertically stacked list of container-like toggles that reveal or hide associated sections of content.
3+
description: >-
4+
An accordion is a vertically stacked list of container-like toggles that
5+
reveal or hide associated sections of content.
46
caption: A list of toggles that reveal or hide associated content.
57
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67221-87751&t=gWdKy44MzTP4cTRo-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/accordion
8-
related: ['components/reveal','components/flyout','components/modal','components/tabs']
8+
figma: >-
9+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67221-87751&t=gWdKy44MzTP4cTRo-1
10+
github: >-
11+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/accordion
12+
related:
13+
- components/reveal
14+
- components/flyout
15+
- components/modal
16+
- components/tabs
917
previewImage: assets/illustrations/components/accordion.jpg
1018
navigation:
1119
hidden: false
12-
keywords: ['toggle', 'disclosure', 'details', 'reveal', 'list', 'summary', 'expand', 'collapse']
20+
keywords:
21+
- toggle
22+
- disclosure
23+
- details
24+
- reveal
25+
- list
26+
- summary
27+
- expand
28+
- collapse
1329
---
1430

1531
<section data-tab="Guidelines">

website/docs/components/alert/index.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,23 @@ title: Alert
33
description: Displays a brief message without interrupting a user’s task.
44
caption: Displays a brief message without interrupting a user’s task.
55
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67382-70353&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/alert
8-
related: ['components/modal', 'components/toast']
6+
figma: >-
7+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67382-70353&t=w8xQlWxzH7bwXLe2-1
8+
github: >-
9+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/alert
10+
related:
11+
- components/modal
12+
- components/toast
913
previewImage: assets/illustrations/components/alert.jpg
1014
navigation:
11-
keywords: ['alert', 'toast', 'notification', 'banner', 'message']
15+
keywords:
16+
- alert
17+
- toast
18+
- notification
19+
- banner
20+
- message
21+
status:
22+
updated: 4.15.0
1223
---
1324

1425
<section data-tab="Guidelines">

website/docs/components/app-footer/index.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
---
22
title: App Footer
3-
description: A footer that appears on every screen to display supplementary information and links.
3+
description: >-
4+
A footer that appears on every screen to display supplementary information and
5+
links.
46
caption: Displays supplementary information and links for the application.
57
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67351-171799&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/app-footer
8-
related: ['layouts/app-frame', 'components/side-nav']
8+
figma: >-
9+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67351-171799&t=w8xQlWxzH7bwXLe2-1
10+
github: >-
11+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/app-footer
12+
related:
13+
- layouts/app-frame
14+
- components/side-nav
915
previewImage: assets/illustrations/components/app-footer.jpg
1016
navigation:
11-
keywords: ['footer', 'copyright', 'support', 'terms', 'privacy', 'security', 'accessibility', 'system status']
17+
keywords:
18+
- footer
19+
- copyright
20+
- support
21+
- terms
22+
- privacy
23+
- security
24+
- accessibility
25+
- system status
1226
---
1327

1428
<section data-tab="Guidelines">
@@ -28,4 +42,4 @@ navigation:
2842

2943
<section data-tab="Accessibility">
3044
@include "partials/accessibility/accessibility.md"
31-
</section>
45+
</section>

website/docs/components/app-header/index.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
11
---
22
title: App Header
3-
description: A header navigation that provides access to global elements and application utilities.
3+
description: >-
4+
A header navigation that provides access to global elements and application
5+
utilities.
46
caption: Used as a global and utility navigation within an application.
57
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67337-16625&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/app-header
8-
related: ['components/side-nav', 'components/app-footer', 'layouts/app-frame']
8+
figma: >-
9+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67337-16625&t=w8xQlWxzH7bwXLe2-1
10+
github: >-
11+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/app-header
12+
related:
13+
- components/side-nav
14+
- components/app-footer
15+
- layouts/app-frame
916
previewImage: assets/illustrations/components/app-header.jpg
1017
navigation:
1118
hidden: true
12-
keywords: ['navigation', 'header', 'navbar', 'menubar', 'topbar']
19+
keywords:
20+
- navigation
21+
- header
22+
- navbar
23+
- menubar
24+
- topbar
1325
---
1426

1527
<section data-tab="Guidelines">

website/docs/components/app-side-nav/index.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
11
---
22
title: App Side Nav
33
description: Used as a contextual navigation for subpages within an application.
4-
caption: A side navigation menu that provides access to subpages within a product or application.
4+
caption: >-
5+
A side navigation menu that provides access to subpages within a product or
6+
application.
57
links:
6-
figma:
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/app-side-nav
8-
related: ['components/side-nav', 'components/breadcrumb','components/tabs','layouts/app-frame','components/app-header']
8+
figma: null
9+
github: >-
10+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/app-side-nav
11+
related:
12+
- components/side-nav
13+
- components/breadcrumb
14+
- components/tabs
15+
- layouts/app-frame
16+
- components/app-header
917
previewImage: assets/illustrations/components/app-side-nav.jpg
1018
navigation:
1119
hidden: true
12-
keywords: ['navigation', 'side navigation', 'sidenav', 'sidebar']
20+
keywords:
21+
- navigation
22+
- side navigation
23+
- sidenav
24+
- sidebar
1325
---
1426

1527
<section data-tab="Guidelines">

website/docs/components/application-state/index.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,16 @@ title: Application State
33
description: An informational element that displays the current state of the application.
44
caption: An informational element that displays the current state of the application.
55
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67278-131631&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/application-state
6+
figma: >-
7+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67278-131631&t=w8xQlWxzH7bwXLe2-1
8+
github: >-
9+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/application-state
810
previewImage: assets/illustrations/components/application-state.jpg
911
navigation:
10-
keywords: ['empty state', 'error state', 'message']
12+
keywords:
13+
- empty state
14+
- error state
15+
- message
1116
---
1217

1318
<section data-tab="Guidelines">

website/docs/components/badge-count/index.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
---
22
title: Badge Count
3-
description: A numeric label used to display things like version number or collection enumerations.
3+
description: >-
4+
A numeric label used to display things like version number or collection
5+
enumerations.
46
caption: A non-interactive numeric label.
57
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67246-60779&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/badge-count
8-
related: ['components/badge', 'components/tag']
8+
figma: >-
9+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67246-60779&t=w8xQlWxzH7bwXLe2-1
10+
github: >-
11+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/badge-count
12+
related:
13+
- components/badge
14+
- components/tag
915
previewImage: assets/illustrations/components/badge-count.jpg
1016
navigation:
11-
keywords: ['chip', 'pill', 'version number', 'counter']
17+
keywords:
18+
- chip
19+
- pill
20+
- version number
21+
- counter
1222
---
1323

1424
<section data-tab="Guidelines">

website/docs/components/badge/index.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
---
22
title: Badge
3-
description: Concise, non-interactive labels that represent metadata.
4-
caption: Concise, non-interactive labels that represent metadata.
3+
description: 'Concise, non-interactive labels that represent metadata.'
4+
caption: 'Concise, non-interactive labels that represent metadata.'
55
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67237-59854&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/badge
8-
related: ['components/badge-count','components/tag']
6+
figma: >-
7+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67237-59854&t=w8xQlWxzH7bwXLe2-1
8+
github: >-
9+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/badge
10+
related:
11+
- components/badge-count
12+
- components/tag
913
previewImage: assets/illustrations/components/badge.jpg
1014
navigation:
11-
keywords: ['chip', 'pill', 'tag', 'label']
15+
keywords:
16+
- chip
17+
- pill
18+
- tag
19+
- label
1220
---
1321

1422
<section data-tab="Guidelines">

website/docs/components/breadcrumb/index.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
11
---
22
title: Breadcrumb
3-
description: A Breadcrumb is a type of secondary navigation that reveals the user’s location in an application.
3+
description: >-
4+
A Breadcrumb is a type of secondary navigation that reveals the user’s
5+
location in an application.
46
caption: A secondary navigation that shows the user’s current location.
57
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67385-83191&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/breadcrumb
8-
related: ['components/side-nav', 'components/tabs']
8+
figma: >-
9+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67385-83191&t=w8xQlWxzH7bwXLe2-1
10+
github: >-
11+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/breadcrumb
12+
related:
13+
- components/side-nav
14+
- components/tabs
915
previewImage: assets/illustrations/components/breadcrumb.jpg
1016
navigation:
11-
keywords: ['navigation', 'crumb', 'path']
17+
keywords:
18+
- navigation
19+
- crumb
20+
- path
1221
---
1322

1423
<section data-tab="Guidelines">

website/docs/components/button-set/index.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,20 @@ title: Button Set
33
description: Provides consistent layout and spacing for a set of buttons.
44
caption: A set of buttons.
55
links:
6-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/button-set
7-
related: ['components/button','patterns/button-organization','components/segmented-group']
6+
github: >-
7+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/button-set
8+
related:
9+
- components/button
10+
- patterns/button-organization
11+
- components/segmented-group
812
previewImage: assets/illustrations/components/button-set.jpg
913
navigation:
10-
keywords: ['button group', 'button', 'button spacing', 'button alignment', 'button layout']
14+
keywords:
15+
- button group
16+
- button
17+
- button spacing
18+
- button alignment
19+
- button layout
1120
---
1221

1322
<section data-tab="Guidelines">

website/docs/components/button/index.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
---
22
title: Button
3-
description: An interactive element that initiates an action or event, such as a form submission.
3+
description: >-
4+
An interactive element that initiates an action or event, such as a form
5+
submission.
46
caption: An interactive element that initiates an action.
57
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67397-95918&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/button
8-
related: ['components/button-set','patterns/button-organization','components/link/inline','components/link/standalone']
8+
figma: >-
9+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67397-95918&t=w8xQlWxzH7bwXLe2-1
10+
github: >-
11+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/button
12+
related:
13+
- components/button-set
14+
- patterns/button-organization
15+
- components/link/inline
16+
- components/link/standalone
917
previewImage: assets/illustrations/components/button.jpg
1018
navigation:
11-
keywords: ['action', 'link']
19+
keywords:
20+
- action
21+
- link
1222
---
1323

1424
<section data-tab="Guidelines">

website/docs/components/card/index.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
---
22
title: Card
3-
description: A block container that provides styling for elevation, border, and background.
4-
caption: A block container that provides styling for elevation, border, and background.
3+
description: 'A block container that provides styling for elevation, border, and background.'
4+
caption: 'A block container that provides styling for elevation, border, and background.'
55
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67251-87362&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/card
6+
figma: >-
7+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67251-87362&t=w8xQlWxzH7bwXLe2-1
8+
github: >-
9+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/card
810
previewImage: assets/illustrations/components/card.jpg
911
navigation:
10-
keywords: ['tile', 'container', 'box']
12+
keywords:
13+
- tile
14+
- container
15+
- box
1116
---
1217

1318
<section data-tab="Guidelines">

website/docs/components/code-block/index.md

+20-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
11
---
22
title: Code Block
3-
description: A container for displaying formatted chunks of code with syntax highlighting and related features.
3+
description: >-
4+
A container for displaying formatted chunks of code with syntax highlighting
5+
and related features.
46
caption: A container for formatting chunks of code with syntax highlighting.
57
links:
6-
figma: https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67166-37020&t=w8xQlWxzH7bwXLe2-1
7-
github: https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/code-block
8-
related: ['components/copy/snippet', 'components/copy/button']
8+
figma: >-
9+
https://www.figma.com/design/iweq3r2Pi8xiJfD9e6lOhF/HDS-Components-v2.0?node-id=67166-37020&t=w8xQlWxzH7bwXLe2-1
10+
github: >-
11+
https://github.com/hashicorp/design-system/tree/main/packages/components/src/components/hds/code-block
12+
related:
13+
- components/copy/snippet
14+
- components/copy/button
915
previewImage: assets/illustrations/components/code-block.jpg
1016
navigation:
11-
keywords: ['code', 'snippet', 'copy', 'text', 'editor', 'language', 'example', 'syntax', 'highlight']
12-
status:
13-
updated: 4.13.0
17+
keywords:
18+
- code
19+
- snippet
20+
- copy
21+
- text
22+
- editor
23+
- language
24+
- example
25+
- syntax
26+
- highlight
1427
---
1528

1629
<section data-tab="Guidelines">

0 commit comments

Comments
 (0)