mirror/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-06-19 07:35:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

contrib: update guidelines and archetype for guides

Browse Source 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson
2024-10-30 16:06:52 +01:00
parent 4fdce97ab4
commit 3cc0f0103f
2 changed files with 7 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
archetypes/guides.md
+1 -3
View File
@@ -5,9 +5,7 @@ description: # Meta description for SEO.
summary: | # A summary of what's in this guide summary: | # A summary of what's in this guide
In this guide, ... In this guide, ...
languages: [] # Programming languages used languages: [] # Programming languages used
products: [] # Docker products involved tags: [] # What's it about?
levels: [] # Experience level(s) of the intended audience (beginner|intermediate|advanced)
subjects: [] # What's it about?
params: params:
# time: 10 minutes # time: 10 minutes
--- ---
content/contribute/guides.md
+6 -9
View File
@@ -47,9 +47,8 @@ summary: |
This guide walks you through the steps to containerize a machine learning This guide walks you through the steps to containerize a machine learning
model and deploy it using Docker, enabling scalable and portable AI model and deploy it using Docker, enabling scalable and portable AI
solutions. solutions.
tags: [machine-learning, deployment]
languages: [python] languages: [python]
subjects: [machine-learning, deployment]
levels: [intermediate]
params: params:
time: 30 minutes time: 30 minutes
--- ---
@@ -61,16 +60,14 @@ params:
- `linkTitle` (optional): A shorter title used in navigation menus. - `linkTitle` (optional): A shorter title used in navigation menus.
- `description` (required): A concise description for SEO purposes. - `description` (required): A concise description for SEO purposes.
- `summary` (required): A brief overview of the guide's content. - `summary` (required): A brief overview of the guide's content.
- `languages` (optional): List of programming languages used. - `languages` \* (optional): List of programming languages used.
- `subjects` (optional): Domains or subject areas covered. - `tags` \* (optional): Domains or subject areas covered.
- `levels` (optional): Intended audience experience level (`beginner`, `intermediate`, `advanced`).
- `products` (optional): List of programming languages used.
- `params` - `params`
- `time` (optional): Estimated reading or completion time. - `time` (optional): Estimated reading or completion time.
The `languages`, `subjects`, `levels`, and `products` keys are taxonomies, and \* Do apply at least one of the `languages` or `tags` taxonomies. The values
the values are used to associate the page with the filter options on the guides are used to associate the page with the filter options on the guides landing
landing page. page.
## Document structure ## Document structure