Skip to content

Commit e0c8325

Browse files
rseseCopilot
andauthored
document journeyTracks frontmatter ✏️ (#57976)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent c427ce7 commit e0c8325

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

content/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ See the [contributing docs](https://docs.github.com/en/contributing) for general
2525
- [`defaultTool`](#defaulttool)
2626
- [`learningTracks`](#learningtracks)
2727
- [`includeGuides`](#includeguides)
28+
- [`journeyTracks`](#journeytracks)
2829
- [`type`](#type)
2930
- [`topics`](#topics)
3031
- [`communityRedirect`](#communityRedirect)
@@ -252,6 +253,35 @@ includeGuides:
252253
- /actions/guides/building-and-testing-powershell
253254
```
254255

256+
### `journeyTracks`
257+
- Purpose: Define journeys for journey landing pages.
258+
- Type: `Array` of objects with the following properties:
259+
- `id` (required): Unique identifier for the journey. The id only needs to be unique for journeys within a single journey landing page.
260+
- `title` (required): Display title for the journey (supports Liquid variables)
261+
- `description` (optional): Description of the journey (supports Liquid variables)
262+
- `guides` (required): Array of article paths that make up this journey
263+
- Only applicable when used with `layout: journey-landing`.
264+
- Optional.
265+
266+
Example:
267+
268+
```yaml
269+
journeyTracks:
270+
- id: 'getting_started'
271+
title: 'Getting started with {% data variables.product.prodname_actions %}'
272+
description: 'Learn the basics of GitHub Actions.'
273+
guides:
274+
- '/actions/quickstart'
275+
- '/actions/learn-github-actions'
276+
- '/actions/using-workflows'
277+
- id: 'advanced'
278+
title: 'Advanced {% data variables.product.prodname_actions %}'
279+
description: 'Dive deeper into advanced features.'
280+
guides:
281+
- '/actions/using-workflows/workflow-syntax-for-github-actions'
282+
- '/actions/deployment/deploying-with-github-actions'
283+
```
284+
255285
### `type`
256286
- Purpose: Indicate the type of article.
257287
- Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.

content/contributing/writing-for-github-docs/using-yaml-frontmatter.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ For more information, see [`lib/frontmatter.js`](https://github.com/github/docs/
3939
* [`defaultTool`](#defaulttool)
4040
* [`learningTracks`](#learningtracks)
4141
* [`includeGuides`](#includeguides)
42+
* [`journeyTracks`](#journeytracks)
4243
* [`type`](#type)
4344
* [`topics`](#topics)
4445
* [`communityRedirect`](#communityredirect)
@@ -249,6 +250,36 @@ includeGuides:
249250
- /actions/guides/building-and-testing-powershell
250251
```
251252

253+
### `journeyTracks`
254+
255+
* Purpose: Define journeys for journey landing pages.
256+
* Type: `Array` of objects with the following properties:
257+
* `id` (required): Unique identifier for the journey. The id only needs to be unique for journeys within a single journey landing page.
258+
* `title` (required): Display title for the journey (supports Liquid variables)
259+
* `description` (optional): Description of the journey (supports Liquid variables)
260+
* `guides` (required): Array of article paths that make up this journey
261+
* Only applicable when used with `layout: journey-landing`.
262+
* Optional.
263+
264+
Example:
265+
266+
```yaml
267+
journeyTracks:
268+
- id: 'getting_started'
269+
title: 'Getting started with {% data variables.product.prodname_actions %}'
270+
description: 'Learn the basics of GitHub Actions.'
271+
guides:
272+
- '/actions/quickstart'
273+
- '/actions/learn-github-actions'
274+
- '/actions/using-workflows'
275+
- id: 'advanced'
276+
title: 'Advanced {% data variables.product.prodname_actions %}'
277+
description: 'Dive deeper into advanced features.'
278+
guides:
279+
- '/actions/using-workflows/workflow-syntax-for-github-actions'
280+
- '/actions/deployment/deploying-with-github-actions'
281+
```
282+
252283
### `type`
253284

254285
* Purpose: Indicate the type of article.

0 commit comments

Comments
 (0)