From 3cc0f0103f888f1f8e88ccc886f60c7f5c3ad006 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 30 Oct 2024 16:06:52 +0100 Subject: [PATCH] contrib: update guidelines and archetype for guides Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- archetypes/guides.md | 4 +--- content/contribute/guides.md | 15 ++++++--------- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/archetypes/guides.md b/archetypes/guides.md index e92dea7389..dfe4f2df68 100644 --- a/archetypes/guides.md +++ b/archetypes/guides.md @@ -5,9 +5,7 @@ description: # Meta description for SEO. summary: | # A summary of what's in this guide In this guide, ... languages: [] # Programming languages used -products: [] # Docker products involved -levels: [] # Experience level(s) of the intended audience (beginner|intermediate|advanced) -subjects: [] # What's it about? +tags: [] # What's it about? params: # time: 10 minutes --- diff --git a/content/contribute/guides.md b/content/contribute/guides.md index ac77538746..fc364d6764 100644 --- a/content/contribute/guides.md +++ b/content/contribute/guides.md @@ -47,9 +47,8 @@ summary: | This guide walks you through the steps to containerize a machine learning model and deploy it using Docker, enabling scalable and portable AI solutions. +tags: [machine-learning, deployment] languages: [python] -subjects: [machine-learning, deployment] -levels: [intermediate] params: time: 30 minutes --- @@ -61,16 +60,14 @@ params: - `linkTitle` (optional): A shorter title used in navigation menus. - `description` (required): A concise description for SEO purposes. - `summary` (required): A brief overview of the guide's content. -- `languages` (optional): List of programming languages used. -- `subjects` (optional): Domains or subject areas covered. -- `levels` (optional): Intended audience experience level (`beginner`, `intermediate`, `advanced`). -- `products` (optional): List of programming languages used. +- `languages` \* (optional): List of programming languages used. +- `tags` \* (optional): Domains or subject areas covered. - `params` - `time` (optional): Estimated reading or completion time. -The `languages`, `subjects`, `levels`, and `products` keys are taxonomies, and -the values are used to associate the page with the filter options on the guides -landing page. +\* Do apply at least one of the `languages` or `tags` taxonomies. The values +are used to associate the page with the filter options on the guides landing +page. ## Document structure