Skip to content

Commit

Permalink
Images section reorganization, 2024 (#1979)
Browse files Browse the repository at this point in the history
## Type of change
<!-- Please be sure to add the appropriate label to your PR. -->
This PR is a massive reorganization of the Images section on academy.

### What should this PR do?
<!-- Does this PR resolve an issue? Please include a reference to it.
-->
resolves chainguard-dev/internal#4492

### Why are we making this change?
<!-- What larger problem does this PR address? -->
The images section continues to grow and has become rather unwieldy in
recent months. This is an attempt to streamline information and improve
discoverability.

### What are the acceptance criteria? 
<!-- What should be happening for this PR to be accepted? Please list
criteria. -->
<!-- Do any stakeholders need to be tagged in this review? If so, please
add them. -->
I did my best to implement the team's suggestions so far. I also tried
to be diligent about adding aliases for each doc I moved. I think a
close look at everything is in order.

### How should this PR be tested?
<!-- What should your reviewer do to test this PR? Please list steps.
-->
Just click around and let me know if I missed anything important!

preview link:
https://deploy-preview-1979--ornate-narwhal-088216.netlify.app/chainguard/chainguard-images/

---------

Signed-off-by: Mark Drake <[email protected]>
  • Loading branch information
SharpRake authored Dec 20, 2024
1 parent d61d50d commit c423528
Show file tree
Hide file tree
Showing 92 changed files with 385 additions and 182 deletions.
2 changes: 1 addition & 1 deletion content/chainguard/chainguard-images/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ banner: {
title: "Migrate to Chainguard Images",
subtitle: "Learn how to reduce your CVE attack surface by using Chainguard Images",
cta: "Read more",
link: "/chainguard/chainguard-images/how-to-use-chainguard-images/"
link: "/chainguard/chainguard-images/how-to-use/how-to-use-chainguard-images/"
}
sectiontitle: "Popular Chainguard Images"
tutorials: [
Expand Down
52 changes: 52 additions & 0 deletions content/chainguard/chainguard-images/about/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: "About Chainguard Images"
linktitle: "About"
description: "Conceptual articles and resources on Chainguard Images"
type: "article"
date: 2024-12-19T08:49:15+00:00
lastmod: 2024-12-19T08:49:15+00:00
draft: false
images: []
weight: 015
topic: true
banner: {
image: "/icon-box-fill.svg",
title: "Chainguard Shared Responsibility Model",
cta: "Read more",
link: "/chainguard/chainguard-images/about/shared-responsibility-model/"
}
sectiontitle: "More on Chainguard Images"
tutorials: [
{
title: "Getting Started with Distroless",
description: "",
url: "/chainguard/chainguard-images/about/getting-started-distroless/"
},
{
title: "How Chainguard Images are Tested",
description: "",
url: "/chainguard/chainguard-images/about/images-testing/"
},
{
title: "Why Our Images Have Low-to-No CVEs",
description: "",
url: "/chainguard/chainguard-images/about/zerocve/"
},
{
title: "Images for Compiled Programs",
description: "",
url: "/chainguard/chainguard-images/working-with-images/about/images-compiled-programs/compiled-programs"
},
{
title: "Dev vs. Production Images",
description: "",
url: "/chainguard/chainguard-images/about/differences-development-production/"
},
{
title: "Product Release Lifecycle",
description: "",
url: "/chainguard/chainguard-images/about/versions/"
},
]

---
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "Beyond Zero: Eliminating Vulnerabilities in PyTorch Container Images (PyTorch 2024)"
linktitle: "Beyond Zero at PyTorch 2024"
linktitle: "Video: Beyond Zero at PyTorch 2024"
aliases:
- /chainguard/chainguard-images/videos/beyond_zero_pytorch_2024/
- /chainguard/chainguard-images/about/beyond_zero_pytorch_2024/
lead: ""
description: "Video and transcript of presentation at PyTorch 2024 on eliminating CVEs in the PyTorch image, drawing on best practices from Chainguard Images"
type: "article"
Expand All @@ -11,7 +14,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 400
weight: 050
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "Differences Between Development and Production Images"
linktitle: " Dev vs. Production Images"
linktitle: "Dev vs. Production Images"
aliases:
- /chainguard/chainguard-images/differences-development-production/
- /chainguard/chainguard-images/about/differences-development-production/
type: "article"
description: "Learn about the differences between development and production Chainguard Images"
date: 2024-11-01T07:52:00+02:00
Expand All @@ -11,7 +14,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 605
weight: 020
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "Getting Started with Distroless Images"
linktitle: "Going Distroless"
aliases:
- /chainguard/chainguard-images/getting-started-distroless/
- /chainguard/chainguard-images/about/getting-started-distroless/
type: "article"
description: "How to leverage distroless images for improved container security"
date: 2024-03-21T08:49:31+00:00
Expand All @@ -11,7 +14,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 030
weight: 010
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ title: "Working with Images for Compiled Programs"
linktitle: "Images for Compiled Programs"
aliases:
- /chainguard/chainguard-images/working-with-images/compiled-programs
- /chainguard/chainguard-images/working-with-images/images-compiled-programs
- /chainguard/chainguard-images/working-with-images/about/images-compiled-programs
description: "Guides on working with compiled programs"
type: "article"
date: 2024-08-26T18:42:57+00:00
lastmod: 2024-08-26T18:42:57+00:00
draft: false
images: []
weight: 200
weight: 030
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Choosing an Image for your Compiled Programs"
linktitle: "Images for Compiled Programs"
aliases:
- /chainguard/chainguard-images/working-with-images/compiled-programs/
- /chainguard/chainguard-images/working-with-images/images-compiled-programs/compiled-programs
- /chainguard/chainguard-images/working-with-images/about/images-compiled-programs/compiled-programs
type: "article"
description: "An overview comparing various Chainguard Images for compiled programs"
date: 2024-07-12T17:55:01+00:00
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "glibc vs. musl"
linktitle: "glibc vs. musl"
aliases:
- /chainguard/chainguard-images/working-with-images/images-compiled-programs/glibc-vs-musl/
- /chainguard/chainguard-images/working-with-images/images-compiled-programs/about/glibc-vs-musl/
type: "article"
description: "An overview of the differences between glibc and musl."
date: 2024-08-26T18:42:57+00:00
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "How Chainguard Images are Tested"
linktitle: "How Images are Tested"
aliases:
- /chainguard/chainguard-images/images-testing/
- /chainguard/chainguard-images/about/images-testing/
type: "article"
description: "A conceptual article outlining testing requirements for Chainguard Images."
date: 2024-03-21T11:07:52+02:00
Expand All @@ -11,7 +14,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 550
weight: 015
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Chainguard Shared Responsibility Model"
linktitle: "Shared Responsibility Model"
aliases:
- /chainguard/chainguard-images/recommended-practices/shared-responsibility-model
- /chainguard/chainguard-images/about/shared-responsibility-model
type: "article"
description: "Reference guide outlining Chainguard's Shared Responsibility model: a framework that clarifies security obligations for hardened container images."
date: 2024-10-17T11:07:52+02:00
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "Chainguard Images Product Release Lifecycle"
linktitle: "Product Release Lifecycle"
aliases:
- /chainguard/chainguard-images/versions/
- /chainguard/chainguard-images/about/versions/
type: "article"
description: "Understanding Chainguard's Approach to Image Versions"
date: 2024-01-08T08:49:31+00:00
Expand All @@ -11,7 +14,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 600
weight: 025
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "How Chainguard Creates Container Images with Low-to-No CVEs"
linktitle: "Why our images have Low-to-No CVEs"
linktitle: "Video: Why Our Images Have Low-to-No CVEs"
aliases:
- /chainguard/chainguard-images/videos/zerocve/
- /chainguard/chainguard-images/about/zerocve/
lead: ""
description: "This video explains how Chainguard is able to create container images with low-to-no
CVEs."
Expand All @@ -12,7 +15,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 070
weight: 035
toc: true
---

Expand Down
2 changes: 1 addition & 1 deletion content/chainguard/chainguard-images/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 015
weight: 060
toc: true
---

Expand Down
55 changes: 55 additions & 0 deletions content/chainguard/chainguard-images/features/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "Chainguard Images Features"
linktitle: "Features"
aliases:
- /chainguard/chainguard-images/images-features
- /chainguard/chainguard-images/images-features
description: "Resources on Chainguard Images' features and how to use them"
type: "article"
date: 2024-12-19T08:49:15+00:00
lastmod: 2024-12-19T08:49:15+00:00
draft: false
images: []
weight: 020
topic: true
banner: {
image: "/icon-box-fill.svg",
title: "FIPS-enabled Images",
cta: "Read more",
link: "/chainguard/chainguard-images/features/fips-images/"
}
sectiontitle: "Chainguard Images Features & Resources"
tutorials: [
{
title: "Image STIGs",
description: "",
url: "/chainguard/chainguard-images/features/image-stigs/"
},
{
title: "Custom Certificates",
description: "",
url: "/chainguard/chainguard-images/features/incert-custom-certs/"
},
{
title: "Unique Tags",
description: "",
url: "/chainguard/chainguard-images/features/unique-tags/"
},
{
title: "CVE Visualizations",
description: "",
url: "/chainguard/chainguard-images/features/cve_visualizations/"
},
{
title: "Tag History API",
description: "",
url: "/chainguard/chainguard-images/features/using-the-tag-history-api/"
},
{
title: "EOL Notifications",
description: "",
url: "/chainguard/chainguard-images/features/eol-notifications/"
},
]

---
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "Using CVE Visualizations"
linktitle: "CVE Visualizations"
aliases:
- /chainguard/chainguard-images/working-with-images/cve_visualizations/
- /chainguard/chainguard-images/features/cve_visualizations/
type: "article"
description: "Getting started with the CVE Visualization feature."
date: 2024-12-04T11:07:52+02:00
Expand All @@ -11,7 +14,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 020
weight: 025
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Chainguard Images End-of-Life Notifications"
linktitle: "EOL Notifications"
aliases:
- /chainguard/chainguard-images/images-features/eol-notifications
- /chainguard/chainguard-images/working-with-images/eol-notifications/
- /chainguard/chainguard-images/features/eol-notifications/
lead: "Email-based alerts for EOL events"
type: "article"
description: "User notifications for end-of-life events related to Chainguard Images"
Expand All @@ -12,7 +14,7 @@ draft: false
tags: ["Chainguard Images", "Product", "Reference"]
images: []
toc: true
weight: 070
weight: 035
---

Chainguard Images are continually rebuilt with the latest patches released by upstream software. Any time a new software version is released in the open source project, a new Chainguard Image will be built automatically.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ linktitle: "FIPS Images"
aliases:
- /chainguard/chainguard-images/fips-images
- /chainguard/chainguard-images/images-features/fips-images
- /chainguard/chainguard-images/working-with-images/fips-images/
- /chainguard/chainguard-images/features/fips-images/
type: "article"
description: "A conceptual overview of Chainguard FIPS Images."
date: 2024-02-08T15:56:52-07:00
Expand All @@ -14,7 +16,7 @@ images: []
menu:
docs:
parent: "concepts"
weight: 050
weight: 005
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "STIGs for Chainguard Images"
linktitle: "STIGs"
aliases:
- /chainguard/chainguard-images/working-with-images/image-stigs/
- /chainguard/chainguard-images/features/image-stigs/
type: "article"
description: "A conceptual overview of Security Technical Implementation Guides, which are available for Chainguard Images."
date: 2024-06-13T15:56:52-07:00
Expand All @@ -11,7 +14,7 @@ images: []
menu:
docs:
parent: "concepts"
weight: 055
weight: 010
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "How To Use incert to Create Images with Built-in Custom Certificates"
linktitle: "Custom Certificates"
aliases:
- /chainguard/chainguard-images/working-with-images/incert-custom-certs/
- /chainguard/chainguard-images/features/incert-custom-certs/
type: "article"
description: "An overview of how to use incert — a Go program from Chainguard — to create container images with custom certificates built-in to them."
date: 2023-07-03T11:07:52+02:00
Expand All @@ -13,7 +14,7 @@ images: []
menu:
docs:
parent: "working-with-images"
weight: 032
weight: 030
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ linktitle: "Unique Tags"
aliases:
- /chainguard/chainguard-images/unique-tags
- /chainguard/chainguard-images/images-features/unique-tags
- /chainguard/chainguard-images/working-with-images/unique-tags/
- /chainguard/chainguard-images/features/unique-tags/
type: "article"
description: "Overview of what Chainguard's Unique Tags are and how to access them."
date: 2024-02-29T08:49:31+00:00
Expand All @@ -14,7 +16,7 @@ images: []
menu:
docs:
parent: "chainguard-images"
weight: 060
weight: 015
toc: true
---

Expand Down
Loading

0 comments on commit c423528

Please sign in to comment.