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 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 +``` +