Resource Types

Resource types are defined by how a given resource is organized based on details such as how comprehensive or direct it is, what methods and materials are used to teach, and the intended channel where the resource should be published. Before writing an educational resource, it’s helpful to have a clear understanding of the resource type you want to produce, as it can help outline the resource's audience, goals, and structure.

As of this writing, these are the content types and formats we can produce at the Developer Education team.

Resource type	Description	Example
Diagrams / model overviews	Overview of a product’s architecture with diagrams and text.	apko Overview
Reference (feature, policy, etc.)	Description of a feature or implementations’ scope and what it does.	Network Requirements
Automated docs	Automatically generated reference documentation	OpenAPI specification, chainctl docs
FAQs	Frequently asked questions about products and open source projects.	Wolfi FAQs
Procedural tutorials	A how-to or similar procedural article which takes a reader through an entire technical process from start to finish.	How to Port a Sample Application to Chainguard Images
Conceptual guides	A high-level technical guide that introduces concepts to readers without providing procedural examples.	Considerations for Keeping Images Up to Date
Educational repositories	An educational repository of a demo or sample app may tie into procedural tutorials or other educational resources but will live on GitHub.	Hello Wolfi Demo
Troubleshooting tutorials	Troubleshooting tutorials provide technical guidance, supporting a developer who is running into problems.	Troubleshooting apko Builds
Cheat sheets	Cheat sheets are less contextualized than other tutorials, supporting developers in recalling syntax with code examples that work.	Choosing an Image for your Compiled Programs
Videos and social education	A short-form video on a self-contained procedural topic demonstrated through video and audio with closed captioning and transcript.	WTF is a Typo Squatting Attack?
Presentation / Workshop Kits	A self-contained workshop with slide deck, video of workshop, with demo repo and talk track as needed. Can be presented by anyone at Chainguard or in the community.	We are working on bringing Wolfi 101 into a workshop kit.
Comics	Comics invite readers to the Academy through accessible and fun examples relating to software supply chain security, with the goal of sparking curiosity to continue exploring available resources further.	Sea-curing Software With Inky #1 - Fighting Vulnerabilities
Courses	Collections of learning resources curated into a learning pathway, allowing readers to take a deep dive into a particular subject.	Painless Vulnerability Management

The following are other content types we’re considering for the future:

• Quickstart tutorials
• Infographics
• Tutorial Series / Learning Pathways