Skip to content

Commit

Permalink
Updating melange docs (#1735)
Browse files Browse the repository at this point in the history
This PR brings several updates to the melange docs.

- Reference documentation was removed and rules were added to the
`nginx.conf` file to redirect to respective doc pages on melange's
GitHub repo
- FAQ was updated
- Overview was simplified
- Getting Started guide was fully fixed and updated to use Wolfi. The
demo repository was reactivated and updated, guide now follows the
content from the repo.

Whenever possible, I linked to the official repo. As of today, searching
for "melange apk" still brings our Getting Started with melange guide as
first result, so I wanted to make sure the guide works, uses Wolfi as
reference, and links back to the repo in relevant places.

All lastmod dates were updated.

This PR addresses [this internal
issue](chainguard-dev/internal#4088).
  • Loading branch information
erikaheidi authored Aug 2, 2024
1 parent de4fe53 commit 9c1d109
Show file tree
Hide file tree
Showing 30 changed files with 80 additions and 1,176 deletions.
2 changes: 1 addition & 1 deletion content/open-source/build-tools/melange/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "An apk builder tool"
lead: "The declarative APK builder"
type: "article"
date: 2020-10-06T08:49:15+00:00
lastmod: 2024-05-02T08:49:15+00:00
lastmod: 2024-08-01T08:49:15+00:00
draft: false
images: []
---
Expand Down
14 changes: 6 additions & 8 deletions content/open-source/build-tools/melange/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ type: "article"
lead: "Frequently asked questions about melange"
description: "Frequently asked questions about melange"
date: 2022-10-17T11:07:52+02:00
lastmod: 2022-10-17T11:07:52+02:00
lastmod: 2024-08-01T11:07:52+02:00
draft: false
tags: ["melange", "FAQ"]
images: []
Expand All @@ -18,25 +18,23 @@ toc: true
---

## Do I need to understand melange to use Chainguard Images?

No. Chainguard built [melange](https://github.com/chainguard-dev/melange) as part of its open source tooling used for the [Wolfi](/open-source/wolfi) operating system. While you can check out the [project on GitHub](https://github.com/chainguard-dev/melange) and learn more, it’s not a prerequisite for using or working with [Chainguard Images](/chainguard/chainguard-images).

## How are melange packages defined?
melange apks are defined declaratively using a YAML file.
melange apks are defined declaratively using a YAML file. This design feature allows for reproducible builds: run melange twice and you'll get exactly the same binary.

## Are melange apks compatible with Alpine?
Yes, melange apks are built to be compatible with apk-based systems including Alpine.
## Is melange compatible with Alpine?
Yes, melange is built to be compatible with apk-based systems including Alpine.

## Can I mix Alpine and Wolfi package repositories to create my melange build environment?
No, it's not possible to mix Alpine apks with Wolfi apks. If you have unmet dependencies, you'll need to build those first as separate packages.
No, it's not possible to mix Alpine apks with Wolfi apks.

## Is it mandatory to sign packages with a melange key?
Signing packages is not mandatory, but it is a recommended practice, because it allows users and automated systems to verify that the package they downloaded was built by the same person who signed it, and that it hasn't been tampered with.

## What happens if I don't provide a key to sign my package(s)?
Some systems may prevent installation of your apk if they can't attest the package provenance. This is the case with apko, which by default will fail any builds that reference unsigned packages.
Some systems may prevent installation of your apk if they can't attest the package provenance. This is the case with [apko](https://github.com/chainguard-dev/apko), which by default will fail any builds that reference unsigned packages.

## Can I create custom pipelines and embed them into my main pipeline?
Although melange supports inclusion of sub-pipelines, this feature currently only supports the built-in pipelines (such as `make`, `split` and others) that can be found at the [pkg/build/pipelines](https://github.com/chainguard-dev/melange/tree/main/pkg/build/pipelines) directory on the main project repository.
The ability to embed custom pipelines is on the roadmap, but it's not a priority at the moment.

246 changes: 64 additions & 182 deletions content/open-source/build-tools/melange/getting-started-with-melange.md

Large diffs are not rendered by default.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

44 changes: 0 additions & 44 deletions content/open-source/build-tools/melange/melange-pipelines/fetch.md

This file was deleted.

This file was deleted.

Loading

0 comments on commit 9c1d109

Please sign in to comment.