From 8a1959b2d26ef9b5e7df70ac74a418a6a55aeba5 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Tue, 16 Jul 2024 14:55:12 -0400 Subject: [PATCH 1/2] ci: Document building the docs locally It was slightly less than obvious. Signed-off-by: Colin Walters --- .github/workflows/docs.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 094f239f2..9c816a8c3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,6 +14,12 @@ concurrency: group: "pages" cancel-in-progress: false +# To build the docs locally you can also do e.g.: +# cargo install mdbook-mermaid +# cd docs +# mdbook-mermaid install +# mdbook serve + jobs: build: runs-on: ubuntu-latest From f68ef1af2b65cfd5dc8c578bcd7fb9a4f59975c6 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Tue, 16 Jul 2024 14:55:27 -0400 Subject: [PATCH 2/2] docs: Add experimental section w/`bootc image` Let's follow a standard operating procedure for our experimental features: - A github tracking issue - A documentation section like this one Signed-off-by: Colin Walters --- docs/src/SUMMARY.md | 4 ++++ docs/src/experimental-bootc-image.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/src/experimental-bootc-image.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index e6a6a8dc7..be995b26b 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -44,6 +44,10 @@ - [Filesystem: sysroot](filesystem-sysroot.md) - [Container storage](filesystem-storage.md) +# Experimental features + +- [bootc image](experimental-bootc-image.md) + # More information - [Package manager integration](package-managers.md) diff --git a/docs/src/experimental-bootc-image.md b/docs/src/experimental-bootc-image.md new file mode 100644 index 000000000..f8a190858 --- /dev/null +++ b/docs/src/experimental-bootc-image.md @@ -0,0 +1,28 @@ +# bootc image + +Experimental features are subject to change or removal. Please +do provide feedback on them. + +Tracking issue: + +## Using `bootc image copy-to-storage` + +This experimental command is intended to aid in [booting local builds](booting-local-builds.md). + +Invoking this command will default to copying the booted container image into the `containers-storage:` +area as used by e.g. `podman`, under the image tag `localhost/bootc` by default. It can +then be managed independently; used as a base image, pushed to a registry, etc. + +Run `bootc image copy-to-storage --help` for more options. + +Example workflow: + +``` +$ bootc image copy-to-storage +$ cat Containerfile +FROM localhost/bootc +... +$ podman build -t localhost/bootc-custom . +$ bootc switch --transport containers-storage localhost/bootc-custom +``` +