Resources are additional materials that learners may refer to while taking a lab or course. They show up in the student resources section of the lab's control panel (example)
We encourage content authors to use as few external links as possible. Qwiklabs cannot guarantee that those links will be available when a learner takes your lab or course. For instance, if you have a PDF that you wish to include, you should add it as a file in this bundle instead of referencing it as a link to Cloud Storage or S3.
For files larger than 50MB, please use an externally referenced resource. Your entire content bundle should be less than 100MB.
Note: If you are linking to an external resource that has its own understanding of source control, please link to the specific revision of that resource. That way, if the external resource is updated, your learners will not be affected. For example, if you are referencing a Github repo, include the link to a specific tag, instead of the default branch.
Brittle: https://github.com/CloudVLab/qwiklabs-lab-bundle-spec/
Better: https://github.com/CloudVLab/qwiklabs-lab-bundle-spec/tree/v1-prerelease
| attribute | required | type | notes |
|---|---|---|---|
| type | ✓ | enum | [See list of valid types below] |
| id | string | Identifier that can be used throughout project bundle and translation pipeline | |
| title | ✓ | dictionary | Localized title of the resource |
| description | dictionary | Localized description of the resource | |
| uri | dictionary | Localized URI of the resource |
Videos for general container entities (non-labs) have the following additional attributes:
| attribute | required | type | notes |
|---|---|---|---|
| video_id | ✓ | dictionary | Localized video_ids as defined by the video provider. For example, a YouTube video_id has the form dQw4w9WgXcQ |
| video_provider | ✓ | string | The video provider, e.g. YouTube |
| duration | ✓ | integer | The duration of the video (in seconds). |
resources:
- type: link
id: repo-link
title: Self-referential Github Repo
uri: https://github.com/CloudVLab/qwiklabs-lab-bundle-spec/tree/v1-prerelease
- type: file
title: Sample PDF
description: This PDF contains all of the code samples for the lab.
uri: "./resources/sample-en.pdf"
- type: video
id: course-video
title: Welcome to GCP!
video_id: oHg5SJYRHA0
video_provider: YouTube
duration: 360
- type: html_bundle
title: Sample HTML
description: This HTML page makes learning interactive.
uri: "https://storage.googleapis.com/cloud-training/cls-html5-courses/C-GTI-I/index.html"file- A relative path to a file in the bundlelink- A url to an external resourcevideo- A link to a video outside of the bundle such as on Youtubehtml_bundle- A url to an HTML file. The file must be stored in the Cloud Training GCS bucket: https://pantheon.corp.google.com/storage/browser/cloud-training.
To prevent confusion, all resources must explicitly define what type they are.
Aside: Why define external resources instead of putting links directly in lab instructions?
You can reference your resource directly in your instructions and will be displayed in a special format, depending on its type. For example, a YouTube link will be displayed as an embedded widget.
You can edit the resource in one location and every place it is referenced will be updated (also across locales).
In courses resources appear as standalone steps, which raises learners' awareness of them.