PR#8: Update the information about Fedora Media Writer, FIXES #7. - fedora-docs/install-guide

fedora-docs / install-guide

#8 Update the information about Fedora Media Writer, FIXES #7.

Merged 5 years ago by pbokoc. Opened 5 years ago by lruzicka.

fedora-docs/ lruzicka/install-guide update_fwm into master

Restructure according to the PR comment.

Lukáš Růžička • 5 years ago

a8683d3

Update the information about Fedora Media Writer, FIXES #7.

Lukas Ruzicka • 5 years ago

828103c

en-US/install/Preparing_for_Installation.adoc

file modified

+144 -163

		`@@ -1,6 +1,6 @@`

		`:experimental:`
		`- include::en-US/entities.adoc[]`
		`+ \\include::en-US/entities.adoc[]`

		`[[chap-preparing-for-installation]]`
		`= Preparing for Installation`
		`@@ -21,8 +21,136 @@`
		`Always back up your data before performing an upgrade or reinstalling your system, no matter which method you choose.`
		`====`

		`+ [[sect-preparing-boot-media]]`
		`+ == Preparing Boot Media`
		`+`
		+ Fedora images are `Hybrid ISOs` and can be used to create installation media with both optical and USB disks, for booting on both BIOS and UEFI systems.
		`+`
		`+ === Fedora Media Writer`
		`+`
		`+ [application]Fedora Media Writer has been significantly improved and is now the official, tested and supported way to make bootable media. [application]Fedora Media Writer supports Linux, Mac, and Windows. It is an easy way to make`
		`+ bootable USB media to install Fedora (or other operating systems). Using [application]Fedora Media Writer is strongly encouraged, although other USB media creation software can work as well.`
		`+`
		`+ Some of the new additions to [application]Fedora Media Writer are that Fedora Workstation and Server are easily and quickly accessible from the selection on the main screen. Further choices are available if you select the button below _Custom OS_. This offers a selection of various Fedora Spins, such as XFCE or Mate.`
		`+`
		`+ Historically, universal USB creation tools, such as [application]Unetbootin, are a popular way to create USB installers from ISOs intended for optical media. They typically create a filesystem on the USB drive by extracting files from the image, and writing [application]syslinux bootloader to the device.`
		`+`
		`+ These methods circumvent the boot-loader configuration built into Fedora images, which are pre-partitioned and designed to boot on UEFI systems with SecureBoot enabled as well as BIOS systems, and thus they do not produce consistent results with Fedora images, especially for on UEFI systems.`
		`+`
		`+ The best results are produced by utilities that use a direct write method and do not modify the Fedora image.`
		`+`
		`+ [WARNING]`
		`+ ====`
		`+ Always think twice before writing an image to the device. The media creation methods described in this article are destructive.`
		`+ All data on the USB stick are deleted during the process, so make sure you have a back up of the data on the USB stick. Double check that you have selected correct device to write the image to!`
		`+ ====`
		`+`
		`+ === Installing and running Fedora Media Writer`
		`+`
		`+ ==== On Fedora`
		`+`
		+ On Fedora 25 or later, [application]Fedora Media Writer is available in the default repository. You can use `dnf` to install the
		`+ package.`
		`+`
		`+ . To install the [application]Fedora Media Writer using:`
		`+ +`
		`+ [subs="quotes, macros, attributes"]`
		`+ ----`
		`+ $ [command]#sudo dnf install mediawriter#`
		`+ ----`
		`+ +`
		`+ . Run the [application]Fedora Media Writer:`
		`+ +`
		`+ [subs="quotes, macros, attributes"]`
		`+ ----`
		`+ $ [command]#sudo mediawriter#`
		`+ ----`
		`+ +`
		`+ or in [application]Gnome 3 select Activities, then select Utilities, and then click on [application]Fedora Media Writer.`
		`+`
		`+`
		`+ ==== On other Linux distributions`
		`+`
		`+ The best way to install [application]Fedora Media Writer on various Linux distributions is to use the pre-built _Flatpak_ package.`
		`+ The package can be obtained from the official Flatpak repository https://flathub.org/apps/details/org.fedoraproject.MediaWriter[Flathub.org].`
		`+`
		`+ . To setup Flatpak on your Linux system, follow the guidelines on the https://flatpak.org/setup/[Flatpak documentation] page.`
		`+`
		`+ . Run the application:`
		`+ +`
		`+ [subs="quotes, macros, attributes"]`
		`+ ----`
		`+ $ [command]#sudo mediawriter#`
		`+ ----`
		`+`
		`+ ==== On Windows`
		`+`
		`+ . Download the latest Windows Installer file from link:++https://getfedora.org++[GetFedora.org]. The server automatically detects the running system and offers you the correct installation file for your Windows version.`
		`+`
		`+ . Run the installation by double clicking the installer, and then continue through the set-up wizard. The Wizard lets you customize the software's installation if you choose to.`
		`+`
		`+ . Run the application by clicking on a launcher.`
		`+ +`
		`+ In Windows 8 and 10, the [application]Fedora Media Writer launcher will be placed in the _All apps_ menu under _F_. In Windows 10, you can just type [application]Fedora Media Writer in the search box on the task bar.`
		`+`
		`+`
		`+ ==== On MacOS`
		`+`
		`+ . Download the latest Macintosh Disk Image (the package will have a .dmg extension) from link:++https://getfedora.org[GetFedora.org]. The server automatically detects the running system and offers a correct package for your MacOS.`
		`+`
		+ . Open the `.dmg` file and copy the `mediawriter` file into your applications folder.
		`+`
		`+ . Navigate to your applications directory, and then launch the [application]Fedora Media Writer application.`
		`+`
		`+ . Select "Open" to run the program, when MacOS will ask you to confirm the action.`
		`+`
		`+ === Writing the ISO image to the USB Media.`
		`+ . Select the Fedora Edition you wish to make a bootable USB drive for.`
		`+ +`
		`+ [[figu-fedora_media_writer_choose_flavor_linux]]`
		`+ .Fedora Media Writer Main Screen: Choose your Edition of Fedora`
		`+ +`
		`+ image::fedora_media_writer/main_screen.png[Image of Fedora Media Writer Main Screen]`
		`+ +`
		`+ The main selection lets you choose one of the default Fedora editions, Fedora Workstation or Server. [application]Fedora Media Writer displays more details about the edition before you can proceed with downloading the image and the USB creation. You can choose a different architecture, if you select _Other variants_.`
		`+`
		`+ . Select "Create Live USB" to proceed.`
		`+ +`
		`+ [[figu-fedora_media_writer_distro_information_fedora]]`
		`+ .Fedora Media Writer Distro Information`
		`+ +`
		`+ image::fedora_media_writer/distro_information.png[Image of Fedora Media Writer Distro Information Screen]`
		`+ +`
		`+ Fedora Media Writer will automatically download the ISO for you. If you have downloaded the ISO before and placed it in the _Downloads_ directory, it will be immediately available to use.`
		`+ +`
		`+ [[figu-fedora_media_writer_Automatic_download_fedora]]`
		`+ .Fedora Media Writer Automatic Download`
		`+ +`
		`+ image::fedora_media_writer/automatic_download.png[Image of Fedora Media Writer Automatic Download]`
		`+`
		`+ . Plug in a USB drive on which you want to create the bootable media.`
		`+`
		`+ . To write the image onto the media, click the red btn:[Write to disk] button.`
		`+ +`
		`+ [[figu-fedora_media_writer_write_to_device_linux]]`
		`+ .Fedora Media Writer Write to USB Device`
		`+ +`
		`+ image::fedora_media_writer/write_to_device.png[Image of Fedora Media Writer write to device red button]`
		`+`
		`+ === Other methods to create a live USB`
		`+`
		`+ Using the Fedora Media Writer is highly recommended for everybody, because it offers a reliable way to create a live USB stick for Fedora installation.`
		`+`
		`+ However, some experienced users may prefer to go through the creation process manually. If you decide to do so, you have to download the installation images and use an application to write them onto the USB stick.`
		`+`
		`+ [NOTE]`
		`+ ====`
		`+ If you have downloaded and verified the installation images manually, you still can write them onto the USB stick using Fedora Media Writer.`
		`+ ====`
		`+`
		`+`
		`[[sect-preparing-obtaining-images]]`
		`- == Downloading Boot and Installation Images`
		`+ ==== Downloading Boot and Installation Images`

		The Fedora Project offers different Editions tailored for some specific use cases. Choose the Fedora Edition best for you, or you can build your own by customizing after the installation, or by using a kickstart file as described in xref:../advanced/Kickstart_Installations.adoc#sect-kickstart-file-create[Creating a Kickstart File]. Kickstart installation requires the `netinstall` media type, or a direct installation booting method such as PXE; kickstarts are not supported with live images.

		`@@ -31,16 +159,15 @@`
		`You can also choose a Fedora _Spin_ featuring favorite alternative desktops or tools for specialized tasks at link:++http://spins.fedoraproject.org++[].`

		`[[sect-verifying-images]]`
		`- == Verifying the Downloaded Image`
		`+ ==== Verifying the Downloaded Image`

		Because transmission errors or other problems may corrupt the Fedora image you have downloaded, it is important to verify the file's integrity. After the images are created, an operation is performed on the file that produces a value called a `checksum` using a complex mathematical algorithm. The operation is sufficiently complex that any change to the original file will produce a different checksum.

		By calculating the image's `checksum` on your own computer and comparing it to the original `checksum`, you can verify the image has not been tampered with or corrupted. The original checksum values are provided at link:++https://fedoraproject.org/verify++[], and are [command]#gpg# signed to demonstrate their integrity.

		`[[sect-verifying-windows]]`
		`- === Verifying checksums on Windows systems`
		`+ ==== Verifying checksums on Windows systems`

		`- .Verifying checksums on Windows systems`
		`. Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://fedoraproject.org/verify++[]`

		`. Open a [command]#powershell# session.`
		`@@ -90,9 +217,8 @@`
		`----`

		`[[sect-verifying-nix]]`
		`- === Verifying checksums on Linux and OSX systems`
		`+ ==== Verifying checksums on Linux and OSX systems`

		`- .Verifying checksums on Linux and OSX systems`
		`. Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://fedoraproject.org/verify++[]`

		`. Open a terminal window, and navigate to the directory with the downloaded files.`
		`@@ -118,160 +244,9 @@`
		`$ shasum -a 256 -c *CHECKSUM`
		`----`

		`- [[sect-preparing-boot-media]]`
		`- == Preparing Boot Media`
		`-`
		- Fedora images are `Hybrid ISOs` and can be used to create installation media with both optical and USB disks, for booting on both BIOS and UEFI systems.
		`-`
		`- .Fedora Media Writer and Universal USB Creators`
		`- [IMPORTANT]`
		`- ====`
		`-`
		`- [application]Fedora Media Writer has been improved and is now the default way to make bootable media. [application]Fedora Media Writer supports Linux, Mac, and Windows. It is an easy way to make`
		`- bootable USB media to install Fedora (or other operating systems). While use of Fedora Media Writer is strongly encouraged, other USB media creation software can work as well.`
		`-`
		`- Some of the new additions to [application]Fedora Media Writer are that Fedora Workstation and Server are the first choices on the main screen. However more choices are available if you select`
		`- the button below "Custom OS". Options like Fedora Spins will appear. Fedora Spins such as XFCE and Mate will be selectable.`
		`-`
		`- Universal USB creation tools such as [application]Unetbootin are a historically popular way to create USB installers from ISOs intended for optical media. They typically function by creating a filesystem on the USB drive, extracting files from the image, and writing [application]syslinux bootloader to the device.`
		`-`
		`- These methods circumvent the boot-loader configuration built into Fedora images, which are pre-partitioned and designed to boot on UEFI systems with SecureBoot enabled as well as BIOS systems. They do not produce a consistent result with Fedora's images, especially for use with UEFI systems.`
		`-`
		`- Utilities that use a direct write method, and do not modify the Fedora image, will produce the most consistently successful results.`
		`-`
		`- [WARNING]`
		`- ====`
		`- Be sure you choose the right device!`
		`- ====`
		`-`
		`- Most media creation methods in this section are destructive. Ensure you do not need any data on the USB stick, and double check you have chosen the correct device before continuing.`
		`-`
		`- ====`
		`-`
		`- .Creating USB Media on Windows`
		`- . Download the latest Windows Installer file from Marin Briza's github page: link:++https://github.com/MartinBriza/MediaWriter/releases++[https://github.com/MartinBriza/MediaWriter/releases].`
		`-`
		`- . Run the installation by double clicking it, and then clicking next through the set-up wizard. The Wizard gives you the options to customize the software's installation if you choose to.`
		`-`
		`- . In Windows 8 and 10, the application will be under "all apps" under F for [application]Fedora Media Writer. Or in Windows 10, you can just type [application]Fedora Media Writer in the search box on the task bar.`
		`-`
		`- . Select the Fedora Edition you wish to make a bootable USB drive for.`
		`- +`
		`- [[figu-fedora_media_writer_choose_flavor_windows]]`
		`- .Fedora Media Writer Main Screen: Choose your Edition of Fedora`
		`- +`
		`- image::fedora_media_writer/main_screen.png[Image of Fedora Media Writer Main Screen]`
		`-`
		`- . If you choose one of the beginning default Fedora editions, such as Fedora workstation or server. [application]Fedora Media Writer will give you information and details about it before you proceed with the download and USB creation. For Fedora Workstation, you can choose a different architecture, such as 32bit if you select "other architectures". Otherwise select "Create Live USB" to proceed.`
		`- +`
		`- [[figu-fedora_media_writer_distro_information_windows]]`
		`- .Fedora Media Writer Distro Information`
		`- +`
		`- image::fedora_media_writer/distro_information.png[Image of Fedora Media Writer Distro Information Screen]`
		`-`
		`- . Fedora Media Writer will automatically download the ISO for you, but if you all-ready have it in your Downloads directory it will be immediately available to use.`
		`- +`
		`- [[figu-fedora_media_writer_Automatic_download_windows]]`
		`- .Fedora Media Writer Automatic Download`
		`- +`
		`- image::fedora_media_writer/automatic_download.png[Image of Fedora Media Writer Automatic Download]`
		`-`
		`- . After the download completes, or when [application]Fedora Media Writer is ready. Plug in a USB drive you wish to use as a bootable media.`
		`-`
		`- . Click the red "Write to disk" button.`
		`- +`
		`- [[figu-fedora_media_writer_write_to_device_windows]]`
		`- .Fedora Media Writer Write to USB Device`
		`- +`
		`- image::fedora_media_writer/write_to_device.png[Image of Fedora Media Writer write to device red button]`
		`-`
		`- .Creating USB Media with Fedora Media Writer.`
		`- . On Fedora 25 or later, you can download Fedora Media Writer with the command:`
		`- +`
		`- [subs="quotes, macros, attributes"]`
		`- ----`
		`- $ [command]#sudo dnf install mediawriter#`
		`- ----`
		`- +`
		`- . You can call [application]Fedora Media Writer by issuing the command:`
		`- +`
		`- [subs="quotes, macros, attributes"]`
		`- ----`
		`- $ [command]#sudo mediawriter#`
		`- ----`
		`- +`
		`- or in [application]Gnome 3 by selecting Activities, then selecting Utilities, and then selecting [application]Fedora Media Writer.`
		`- +`
		`- . Select the Fedora Edition you wish to make a bootable USB drive for.`
		`- +`
		`- [[figu-fedora_media_writer_choose_flavor_linux]]`
		`- .Fedora Media Writer Main Screen: Choose your Edition of Fedora`
		`- +`
		`- image::fedora_media_writer/main_screen.png[Image of Fedora Media Writer Main Screen]`
		`-`
		`- . If you choose one of the beginning default Fedora editions, such as Fedora workstation or server. [application]Fedora Media Writer will give you information and details about it before you proceed with the download and USB creation. For Fedora Workstation, you can choose a different architecture, such as 32bit if you select "other architectures". Otherwise select "Create Live USB" to proceed.`
		`- +`
		`- [[figu-fedora_media_writer_distro_information_fedora]]`
		`- .Fedora Media Writer Distro Information`
		`- +`
		`- image::fedora_media_writer/distro_information.png[Image of Fedora Media Writer Distro Information Screen]`
		`-`
		`- . Fedora Media Writer will automatically download the ISO for you, but if you all-ready have it in your Downloads directory it will be immediately available to use.`
		`- +`
		`- [[figu-fedora_media_writer_Automatic_download_fedora]]`
		`- .Fedora Media Writer Automatic Download`
		`- +`
		`- image::fedora_media_writer/automatic_download.png[Image of Fedora Media Writer Automatic Download]`
		`+ === Writing the images to USB media`

		`- . After the download completes, or when [application]Fedora Media Writer is ready. Plug in a USB drive you wish to use as a bootable media.`
		`-`
		`- . Click the red "Write to disk" button.`
		`- +`
		`- [[figu-fedora_media_writer_write_to_device_linux]]`
		`- .Fedora Media Writer Write to USB Device`
		`- +`
		`- image::fedora_media_writer/write_to_device.png[Image of Fedora Media Writer write to device red button]`
		`-`
		`- .Creating USB Media on Macintosh`
		`- . Download the latest Macintosh Disk Image (the package will have a .dmg extension) from Marin Briza's github page: link:++https://github.com/MartinBriza/MediaWriter/releases++[https://github.com/MartinBriza/MediaWriter/releases].`
		`-`
		`- . Open the .dmg file and copy the mediawriter file into your applications folder.`
		`-`
		`- . Navigate to your applications directory, and then launch the mediawriter app.`
		`-`
		`- . Mac OS will then ask if you are sure you want to open the file (it is from the internet after all), select "Open" to run the program.`
		`-`
		`- . Select the Fedora Edition you wish to make a bootable USB drive for.`
		`- +`
		`- [[figu-fedora_media_writer_choose_flavor_mac]]`
		`- .Fedora Media Writer Main Screen: Choose your Edition of Fedora`
		`- +`
		`- image::fedora_media_writer/main_screen.png[Image of Fedora Media Writer Main Screen]`
		`-`
		`- . If you choose one of the beginning default Fedora editions, such as Fedora workstation or server. [application]Fedora Media Writer will give you information and details about it before you proceed with the download and USB creation. For Fedora Workstation, you can choose a different architecture, such as 32bit if you select "other architectures". Otherwise select "Create Live USB" to proceed.`
		`- +`
		`- [[figu-fedora_media_writer_distro_information_mac]]`
		`- .Fedora Media Writer Distro Information`
		`- +`
		`- image::fedora_media_writer/distro_information.png[Image of Fedora Media Writer Distro Information Screen]`
		`-`
		`- . Fedora Media Writer will automatically download the ISO for you, but if you all-ready have it in your Downloads directory it will be immediately available to use.`
		`- +`
		`- [[figu-fedora_media_writer_Automatic_download_mac]]`
		`- .Fedora Media Writer Automatic Download`
		`- +`
		`- image::fedora_media_writer/automatic_download.png[Image of Fedora Media Writer Automatic Download]`
		`-`
		`- . After the download completes, or when [application]Fedora Media Writer is ready. Plug in a USB drive you wish to use as a bootable media.`
		`-`
		`- . Click the red "Write to disk" button.`
		`- +`
		`- [[figu-fedora_media_writer_write_to_device_mac]]`
		`- .Fedora Media Writer Write to USB Device`
		`- +`
		`- image::fedora_media_writer/write_to_device.png[Image of Fedora Media Writer write to device red button]`
		`-`
		`- .Creating USB media with [application]GNOME Disks`
		`+ ==== Creating USB media with [application]GNOME Disks`
		. On a system with [application]GNOME, or with the [package]gnome-disk-utility package installed, open `Disks` using the system menu.

		`. Click your USB device in the left column.`
		`@@ -280,7 +255,7 @@`

		. Navigate to your image file and click `Start Restoring`. After a few minutes, it will report the process is complete and your installation media will be ready to use.

		`- .Creating USB Media on the Linux command line`
		`+ ==== Creating USB Media on the Linux command line`
		`. Open a terminal window and insert the usb drive.`

		. Find the `device node` assigned to the drive. In the example below, the drive is given `sdd`.
		`@@ -300,14 +275,20 @@`
		`[288961.876382] sd 6:0:0:0: sdd Attached SCSI removable disk`
		`----`

		`- . Use the [command]#dd# utility to write the image. Make sure you have the right drive!`
		`+ . Use the [command]#dd# utility to write the image.`
		`+`
		`[subs="macros"]`
		`----`
		`# dd if=/path/to/Fedora-Live-Security-x86_64-21.iso of=/dev/sdd`
		`----`
		`+ +`
		`+ [WARNING]`
		`+ ====`
		+ Pay extreme attention to the source (`if=`) and target (`of=`) device. The `dd` command destroys all data on the
		`+ target device. If you made a mistake, you could lose important data.`
		`+ ====`

		`- .Creating a Boot CD or DVD`
		`+ === Creating a Boot CD or DVD`
		`In addition to creating a bootable USB flash drive, you can also use the provided ISO images to create bootable optical media (a CD or DVD). This approach may be necessary when installing {PRODUCT} on an older system which can not boot from USB.`

		`[NOTE]`

lruzicka commented 5 years ago

Mention that FMW is the only supported way to create USB media.
Update Button descriptions and Strings to comply with the latest version
FMW.
Redesign the chapter - create an installation procedure for different
systems and leave only one creating procedure based on Fedora installation.
Rewrite some sentences to improve the text (IMHO).

pbokoc commented 5 years ago

Hi, thank you for your contribution. Everything looks good, but can you please switch the structure around?

I think the section about FMW should come before instructions for manually downloading ISOs and verifying them - since FMW is the preferred way of doing this and it does both automatically. So we should start with that, and then keep instructions for manually downloading, verifying, and writing ISOs to flash drives below for cases where people can't use the writer.

So it should go like this:
= Preparing for installation
== Using Fedora Media Writer
=== Install FMW
=== Run FMW
== Manual setup
=== Download images
=== Verify images
=== Write images