Our mission is to provide education on software supply chain security.
Visit our website at edu.chainguard.dev
You can find the educational resource files in markdown under the content directory.
This site is based off of the Doks Hugo theme.
If you would like to develop this project clone this repo and install dependencies with npm.
npm installTo run a local version of this site, use npm to start it.
npm run startYou'll then navigate to localhost:1313 within the web browser of your choice.
If you identify something that is a major change, please file an issue. If you identify a minor change like a typo that needs to be updated, or tech tooling that has a newer package, you are welcome to open a pull request for review from the team.
In each post's header, the date format should follow year-month-day as YYYY-MM-DD.
Please reduce the image's file size prior to adding the image to this project to make page loadtimes faster and more accessible. You can use a tool such as TinyPNG.
If you are using images, it's best to bundle it together with the appropriate markdown file. Create a directory with the name of the new page. Within the directory, create an index.md file and add the images within the directory as well.
In practice, this will look like the following, with images in place for both the getting-started-enforce-github directory and the install-enforce-github directory and the relevant tutorials:
├── chainguard
│ ├── _index.md
│ ├── enforce-github
│ │ ├── _index.md
│ │ ├── getting-started-enforce-github
│ │ │ ├── check.png
│ │ │ ├── index.md
│ │ │ ├── protected-branch.png
│ │ │ └── repo-access.png
│ │ └── install-enforce-github
│ │ ├── configure.png
│ │ ├── index.md
│ │ ├── permissions.png
│ │ └── user-select.png
Within the markdown file, add images like so, with the alt text at the front:
Run a local development environment to ensure that your file structure is set up as intended.
Use a liquid tag within markdown to embed a YouTube video. For example, if you would like to link to the YouTube video located at https://www.youtube.com/watch?v=rqIcDrg1XOs, you can pull the string after v= and use the following liquid tag on its own line within markdown.
{{< youtube rqIcDrg1XOs >}}
To include an interactive terminal in a given tutorial page, add the following line in the Hugo frontmatter:
terminalImage: imageName:latest
Use one of the following images depending on the topic:
apko:latest
chainguard-images:latest
cosign:latest
images-demos:latest
rekor:latest
vexctl:latest
policy-controller-base:latest
policy-controller-install:latest
The interactive terminal is under active development and not every tool is currently available within the environment.
To add tags to a piece of content, add the following line to the file's front matter:
tags: ["Tag1", Tag2", etc]
This line should appear between the draft line and the images line in the front matter.
For example:
...
draft: false
tags: ["Chainguard Images", "Overview", "Product"]
images: []
menu:
...
When applying tags, please make sure they conform to the working tag list below so that the tagging logic is consistent. If you'd like to add a new tag or suggest a tag revision, please submit a PR with a justification for the change.
Tags are based on:
- Content topics covered in the content, such as tools (Enforce, apko, etc), orgs/standards (OCI, SLSA, etc), and other relevant topics (SBOMs, etc).
- Content types represented by the content, such procedural, conceptual, interactive, troubleshooting, etc.
Tags Working List
Topic tags
- apko
- chainctl
- Cosign
- CVE
- Enforce
- Fulcio
- Chainguard Images
- melange
- OCI
- Policy
- policy-controller
- Product
- Registry
- Rekor
- SBOM
- Sigstore
- SLSA
- VEX
- Wolfi
- Cheat Sheet
- Comic
- Conceptual
- FAQ
- Interactive
- Overview
- Procedural
- Reference
- Troubleshooting
- Video
- Workshop Kit