centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 14:28:47 +07: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

4
archetypes/guides.md
View File

@@ -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
---

15
content/contribute/guides.md
View File

@@ -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