docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #21286 from dvdksn/update-guide-contrib 

contrib: update guidelines and archetype for guides
This commit is contained in:
David Karlsson 2024-10-30 16:28:11 +01:00 committed by GitHub
parent 56e42135a0 3cc0f0103f
commit bbc346b73b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 12 deletions
Show Stats 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 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
--- ---

15
content/contribute/guides.md
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