From 6f0198e3f5ad45039bfb0313680cf3cbe05b023f Mon Sep 17 00:00:00 2001 From: Martin Kolman Date: Wed, 16 Aug 2023 14:50:54 +0200 Subject: [PATCH] Improve image building docs Highlight how to avoid the major pitfalls as well as make this easier to find and link to. Also general readability improvements. --- CONTRIBUTING.rst | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1e5f6afed21..6478a89d589 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -122,23 +122,30 @@ There are two options to develop and test changes which are not yet released. To find out more information about quick way to propagate your changes into the existing installation ISO image see `this blogpost `_. -Another way is to build the boot.iso directly (takes more time but it's easier to do). +Building installation images +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Another way is to build the boot.iso or Live image directly (takes more time but it's easier to do). -Build Anaconda RPM files with our container:: +**First build Anaconda RPM files with our container**:: make -f ./Makefile.am container-rpms-scratch -Then build ISO from these RPMs by this call (beware because of loop device mounting it needs root priviledges):: +Then build an image containing those RPMs. + +**NOTE: Do not run this in the Anaconda toolbox - it will not work due to the need for root privileges.** + +To build a regular boot.iso from these RPMs use (loop device mounting requires root privileges):: sudo make -f ./Makefile.am anaconda-iso-creator-build # to build the container if it doesn't exists already sudo make -f ./Makefile.am container-iso-build -or for Web UI image run:: +To build a Web UI boot.iso run:: sudo make -f ./Makefile.am anaconda-iso-creator-build # to build the container if it doesn't exists already sudo make -f ./Makefile.am container-webui-iso-build -or for Web UI in Live media run:: +To build a Web UI in Live image run:: sudo make -f ./Makefile.am anaconda-live-iso-creator-build # to build the container if it doesn't exists already sudo make -f ./Makefile.am container-live-iso-build