You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Create a guide page for a Labspace. This includes writing the markdown content for the guide,
5
-
structuring it according to Docker docs conventions, and ensuring it provides clear instructions
6
-
and information about the Labspace. Includes learning about the lab itself, extracting out its
7
-
learning objectives, and combining all of that into a well-structured guide markdown file.
3
+
description: "Clone a dockersamples Labspace repo, extract learning objectives and module structure from labspace.yaml, and produce a Hugo guide page under content/guides/ with correct frontmatter, labspace-launch shortcode, and Docker docs style compliance. Use when asked to create a lab guide, write a Labspace page, add a Docker lab tutorial, migrate a lab to docs, or document a hands-on lab."
8
4
---
9
5
10
6
# Create Lab Guide
11
7
12
-
You are creating a new guide page for a labspace. The guide should be structured according to Docker docs conventions,
13
-
with clear sections, learning objectives, and instructions for users to get the most out of the lab.
8
+
Create a guide page for a Docker Labspace: clone the source repo, extract
9
+
structure from `labspace.yaml`, write the Hugo markdown page, and validate.
14
10
15
11
## Inputs
16
12
17
-
The user provides one or more guides to migrate. Resolve these from the inventory below:
18
-
19
13
-**REPO_NAME**: GitHub repo in the `dockersamples` org (e.g. `labspace-ai-fundamentals`)
20
14
21
15
## Step 1: Clone the labspace repo
22
16
23
-
Clone the guide repo to a temporary directory. This gives you all source files locally — no HTTP calls needed.
Where `<tmpdir>` is a temporary directory on your system (e.g. the output of `mktemp -d`).
30
-
31
-
## Step 2: Learn and extract key information about the lab
32
-
33
-
The repo structure is:
22
+
## Step 2: Extract key information
34
23
35
-
-`<tmpdir>/{REPO_NAME}/README.md` — the main README for the lab
36
-
-`<tmpdir>/{REPO_NAME}/labspace/labspace.yaml` — a YAML document outlining details of the lab, including the sections/modules and the path to their content
37
-
-`<tmpdir>/{REPO_NAME}/labspace/*.md` — the content for each section/module (only reference the files specified in `labspace.yaml`)
38
-
-`<tmpdir>/{REPO_NAME}/.github/workflows/` — the GHA workflow that publishes the labspace. It includes the repo URL for the published Compose file, which will be useful for the "launch" command
1. Read `README.md` to understand the purpose of the lab.
42
-
2. Read the `labspace/labspace.yaml` to understand the structure of the lab and its sections/modules.
43
-
3. Read the `labspace/*.md` files to extract the learning objectives, instructions, and any code snippets.
44
-
4. Extract a short description that can be used for the `description` and `summary` fields in the guide markdown.
45
-
5. Determine if a model will be pulled when starting the lab by looking at the `compose.override.yaml` file and looking for the any top-level `model` specifications.
26
+
| File | Purpose |
27
+
|------|---------|
28
+
|`README.md`| Lab purpose and overview |
29
+
|`labspace/labspace.yaml`| Module structure and content paths |
30
+
|`labspace/*.md`| Module content (only files listed in `labspace.yaml`) |
31
+
|`.github/workflows/*.yml`| Published Compose file URL for the launch command |
32
+
|`compose.override.yaml`| Check for top-level `model` specs (triggers `model-download` param) |
46
33
34
+
Extract:
35
+
1. A short description for the `description` and `summary` frontmatter fields.
36
+
2. Learning objectives from the module content.
37
+
3. Whether a model download is required (`compose.override.yaml` → top-level `model` key).
47
38
48
-
## Step 2: Write the guide markdown
39
+
## Step 3: Write the guide markdown
49
40
50
-
The markdown file must be located in the `guides/` directory and have a filename of `lab-{GUIDE_ID}.md`.
51
-
52
-
Sample markdown structure, including frontmatter and content:
41
+
Place the file at `content/guides/lab-{GUIDE_ID}.md`.
53
42
54
43
```markdown
55
44
---
@@ -60,7 +49,7 @@ description: |
60
49
summary: |
61
50
A short summary of the lab for the guides listing page. 2-3 lines.
62
51
keywords: AI, Docker, Model Runner, agentic apps, lab, labspace
63
-
aliases: # Include if the lab is an AI-related lab
0 commit comments