Skip to content

Commit 3cc0f01

Browse files
committedOct 30, 2024·
contrib: update guidelines and archetype for guides
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
1 parent 4fdce97 commit 3cc0f01

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed
 

‎archetypes/guides.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ description: # Meta description for SEO.
55
summary: | # A summary of what's in this guide
66
In this guide, ...
77
languages: [] # Programming languages used
8-
products: [] # Docker products involved
9-
levels: [] # Experience level(s) of the intended audience (beginner|intermediate|advanced)
10-
subjects: [] # What's it about?
8+
tags: [] # What's it about?
119
params:
1210
# time: 10 minutes
1311
---

‎content/contribute/guides.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ summary: |
4747
This guide walks you through the steps to containerize a machine learning
4848
model and deploy it using Docker, enabling scalable and portable AI
4949
solutions.
50+
tags: [machine-learning, deployment]
5051
languages: [python]
51-
subjects: [machine-learning, deployment]
52-
levels: [intermediate]
5352
params:
5453
time: 30 minutes
5554
---
@@ -61,16 +60,14 @@ params:
6160
- `linkTitle` (optional): A shorter title used in navigation menus.
6261
- `description` (required): A concise description for SEO purposes.
6362
- `summary` (required): A brief overview of the guide's content.
64-
- `languages` (optional): List of programming languages used.
65-
- `subjects` (optional): Domains or subject areas covered.
66-
- `levels` (optional): Intended audience experience level (`beginner`, `intermediate`, `advanced`).
67-
- `products` (optional): List of programming languages used.
63+
- `languages` \* (optional): List of programming languages used.
64+
- `tags` \* (optional): Domains or subject areas covered.
6865
- `params`
6966
- `time` (optional): Estimated reading or completion time.
7067

71-
The `languages`, `subjects`, `levels`, and `products` keys are taxonomies, and
72-
the values are used to associate the page with the filter options on the guides
73-
landing page.
68+
\* Do apply at least one of the `languages` or `tags` taxonomies. The values
69+
are used to associate the page with the filter options on the guides landing
70+
page.
7471

7572
## Document structure
7673

0 commit comments

Comments
 (0)
Please sign in to comment.