PR#10: Kickstart: Improve AsciiDoc syntax, add multi-line description lists - i3-sig/docs

i3-sig / docs

#10 Kickstart: Improve AsciiDoc syntax, add multi-line description lists

Merged 3 years ago by x3mboy. Opened 3 years ago by jflory7.

change/ks-cleanup into master

Kickstart: Improve AsciiDoc syntax, add multi-line description lists

Justin W. Flory (he/him) • 3 years ago

db3e894

modules/ROOT/pages/kickstart.adoc

file modified

+29 -21

		`@@ -7,10 +7,6 @@`
		`This page documents the kickstart files used for composing Fedora i3 Spin release images.`
		`Kickstart files are used by build automation to compose build assets, like ISOs.`

		`- [CAUTION]`
		`- ====`
		`- The Fedora i3 Spin kickstart files are in development and not yet ready for release.`
		`- ====`


		`[[end-goal]]`
		`@@ -22,42 +18,54 @@`
		`[[workflow]]`
		`== Workflow`

		`- The SIG is cleaning up the current kickstart files to achieve a minimal kickstart.`
		`- Some of this work includes creating modular components split up into smaller files.`
		`- This will make it easier to propose new packages for the i3 Spin.`
		`+ Coming soon!`
		`+ // We should explain how the kickstart files are split up and what goes into which file: https://pagure.io/i3-sig/Fedora-i3-Spin/tree/master`


		`[[build-iso]]`
		`== How to build an ISO locally`

		- Required packages: `git livecd-creator` or `git lorax`
		`+ Complete the following steps to build a local ISO of the Fedora i3 Spin.`
		`+`
		`+ Install dependencies::`
		+ `sudo dnf install -y lorax`
		`+`
		`+ Clone Spin repository::`
		+ `git clone https://pagure.io/i3-sig/Fedora-i3-Spin.git`

nasirhm commented 3 years ago How about adding changing directory to Fedora-i3-Spin:: `cd Fedora-i3-Spin`
		`- Required permissions: User with sudo permissions`
		`+ Build ISO using Lorax::`
		+ `sudo livemedia-creator --make-iso --ks flat-i3.ks --no-virt --iso-only --iso-name fedora-i3-live-x86_64.iso --releasever 33`
nasirhm commented 3 years ago The resulting ISO wouldn't be in the same directory to be booted by `qemu-kvm` It would be residing in /var/tmp/lmc-result-*/ . https://fedoraproject.org/wiki/Livemedia-creator-_How_to_create_and_use_a_Live_CD#Compose_Results

		`- 1. Clone the repository link:https://pagure.io/i3-sig/Fedora-i3-Spin[Fedora-i3-Spin]`
		`+ Create a QEMU virtual machine with the new ISO::`
		+ `qemu-kvm -m 2048 -vga qxl -cdrom fedora-i3-live-x86_64.iso`

		- `git clone https://pagure.io/i3-sig/Fedora-i3-Spin.git && cd Fedora-i3-Spin`
		`+ [NOTE]`
		`+ ====`
		+ When `--releasever` is not specified, it defaults to the current system version.
		`+ ====`

		`- 2. Build the iso using livecd-creator or using Lorax`
		`+ [[build-iso--alternatives]]`
		`+ === Alternatives`

		- `sudo livecd-creator --verbose --config=flat-i3.ks --fslabel=Fedora-i3-live --releasever=33 --cache=./cache/live --title=Fedora-i3-Spin`
		`+ There are many other ways to build ISOs.`
		`+ This documentation uses Lorax since this is used in Fedora build infrastructure.`
		`+ Try these other ways of building the ISO if you prefer other tooling`

		- `sudo livemedia-creator --make-iso --ks flat-i3.ks --no-virt --iso-only --iso-name fedora-i3-live-x86_64.iso --releasever 33`
		`-`
		`- 3. Run the newly created ISO:`
		`+ [[build-iso--livecd]]`
		`+ ==== livecd-creator`

		- `qemu-kvm -m 2048 -vga qxl -cdrom Fedora-i3-live.iso`
		`+ [source,sh]`
		`+ ----`
		`+ sudo livecd-creator --verbose --config=flat-i3.ks --fslabel=Fedora-i3-live --releasever=33 --cache=./cache/live --title=Fedora-i3-Spin`
		`+ ----`

		`- ====`
		- When no `--releasever` is passed it defaults to the current system's version
		`- ====`

		`[[changelog]]`
		`== Changelog`

		`=== 2020-11-05`

		`- Adding the first step's on how to build the ISO locally,`
		`+ Added first steps on building the ISO locally,`

		`=== 2020-07-10`

jflory7 commented 3 years ago

This commit makes a few improvements and clean-ups to build on PR #9:

Drop note that kickstarts are not ready for public, given that we are
about to submit the F34 Change proposal
Use multi-line description lists to order the steps for building the
ISO with Lorax (they are pretty!)
Leave livecd-creator instructions at the end, since we are trying to
move away from that method
Misc. AsciiDoc formatting and syntax improvements

Closes i3-sig/Fedora-i3-Spin#25.