Skip to content

Academy Tags

Mark Drake edited this page Aug 23, 2024 · 1 revision

Tags are used to help users quickly discover resources relevant to their needs. Tags will also be useful for track Academy metrics in the future.

Currently, 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.

How to Add Tags

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. Make sure your tags are in all uppercase.

For example:

...

draft: false
tags: ["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 create an issue describing your justification for the change on this repository.

Tags Working List

Topics

  • apko
  • chainctl
  • Cosign
  • CVE
  • Enforce
  • Fulcio
  • Chainguard Images
  • melange
  • OCI
  • Policy
  • policy-controller
  • Product
  • Rekor
  • SBOM
  • Sigstore
  • SLSA
  • VEX
  • Wolfi

Type

  • Cheat Sheet
  • Comic
  • Conceptual
  • FAQ
  • Interactive
  • Overview
  • Procedural
  • Reference
  • Troubleshooting
  • Video
  • Workshop Kit

If you have any questions or suggestions regarding our Style Guide, please create an issue and we will follow up accordingly.

Clone this wiki locally