From 28862f4690f183a2f23f28ec7d8ab4bc1a456013 Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Aug 05 2021 12:13:00 +0000 Subject: Present readers with smart quotes Before this change, this documentation in this repo would present the reader with U+0022 QUOTATION MARKs. According to Unicode, it’s better to use U+201C LEFT DOUBLE QUOTATION MARK and U+201D RIGHT DOUBLE QUOTATION MARK (Source: https://www.unicode.org/charts/PDF/U0000.pdf#page=3). --- diff --git a/LICENSE b/LICENSE index c000d13..801e10d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 4.0 International license -("CC BY-SA"). An explanation of CC BY-SA is available at +(“CC BY-SA”). An explanation of CC BY-SA is available at http://creativecommons.org/licenses/by-sa/4.0/. In accordance with CC BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/README.md b/README.md index 0291e70..8700f77 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Fedora Install Guide Please report Issues and submit Pull Requests for **Content Fixes** here. -Have you never done a pull request (or "PR")? Here's the [Pagure documentation for +Have you never done a pull request (or “PR”)? Here's the [Pagure documentation for Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html). diff --git a/modules/install-guide/pages/_partials/Legal_Notice.adoc b/modules/install-guide/pages/_partials/Legal_Notice.adoc index 33a8822..25c7d03 100644 --- a/modules/install-guide/pages/_partials/Legal_Notice.adoc +++ b/modules/install-guide/pages/_partials/Legal_Notice.adoc @@ -3,7 +3,7 @@ Copyright {YEAR} {HOLDER}. -The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 4.0 International license ("CC BY-SA"). An explanation of CC BY-SA is available at link:++https://creativecommons.org/licenses/by-sa/4.0/++[]. The original authors of this document, and Red Hat, designate the Fedora Project as the "Attribution Party" for purposes of CC BY-SA. In accordance with CC BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. +The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 4.0 International license ("`CC BY-SA`"). An explanation of CC BY-SA is available at link:++https://creativecommons.org/licenses/by-sa/4.0/++[]. The original authors of this document, and Red Hat, designate the Fedora Project as the "`Attribution Party`" for purposes of CC BY-SA. In accordance with CC BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC BY-SA to the fullest extent permitted by applicable law. diff --git a/modules/install-guide/pages/_partials/install/CustomSpoke.adoc b/modules/install-guide/pages/_partials/install/CustomSpoke.adoc index de71b22..b6a95f2 100644 --- a/modules/install-guide/pages/_partials/install/CustomSpoke.adoc +++ b/modules/install-guide/pages/_partials/install/CustomSpoke.adoc @@ -6,7 +6,7 @@ The `Manual Partitioning` screen allows you to create a storage configuration for your {PRODUCT} system manually, giving you a greater control over your system's storage. -In most other installers for both Linux and other operating systems, disk partitioning usually takes a "bottom-up" approach. In these installers, you first create underlying devices such as LVM physical volumes, then you create a layout such as LVM on top of them, then you create file systems on top of logical volumes, and the last step is usually assigning a mount point to each volume as needed. +In most other installers for both Linux and other operating systems, disk partitioning usually takes a "`bottom-up`" approach. In these installers, you first create underlying devices such as LVM physical volumes, then you create a layout such as LVM on top of them, then you create file systems on top of logical volumes, and the last step is usually assigning a mount point to each volume as needed. [application]*Anaconda* uses an opposite approach. First, you create all separate mount points you need, and everything needed to create them (creating a volume group, logical volumes inside it, and physical volumes where the volume group will reside) is performed automatically. You can then adjust the automatic settings as you require. diff --git a/modules/install-guide/pages/_partials/install/CustomSpoke_FileSystems.adoc b/modules/install-guide/pages/_partials/install/CustomSpoke_FileSystems.adoc index ec078bf..08dc7a8 100644 --- a/modules/install-guide/pages/_partials/install/CustomSpoke_FileSystems.adoc +++ b/modules/install-guide/pages/_partials/install/CustomSpoke_FileSystems.adoc @@ -53,7 +53,7 @@ Note that the size of an XFS file system can not currently be reduced without de * `RAID1 (Redundancy)` - Mirrors all data from one partition onto one or more other disks. Additional devices in the array provide increasing levels of redundancy. RAID 1 requires at least two disks. -* `RAID4 (Error Checking)` - Distributes data across multiple disks and uses one disk in the array to store parity information which safeguards the array in case any disk within the array fails. Because all parity information is stored on one disk, access to this disk creates a "bottleneck" in the array's performance. Level 4 RAID requires at least three disks. +* `RAID4 (Error Checking)` - Distributes data across multiple disks and uses one disk in the array to store parity information which safeguards the array in case any disk within the array fails. Because all parity information is stored on one disk, access to this disk creates a "`bottleneck`" in the array's performance. Level 4 RAID requires at least three disks. * `RAID5 (Distributed Error Checking)` - Distributes data and parity information across multiple disks. Level 5 RAIDs therefore offer the performance advantages of distributing data across multiple disks, but do not share the performance bottleneck of level 4 RAIDs because the parity information is also distributed through the array. RAID 5 requires at least three disks. diff --git a/modules/install-guide/pages/_partials/install/CustomSpoke_RecommendedScheme.adoc b/modules/install-guide/pages/_partials/install/CustomSpoke_RecommendedScheme.adoc index 2c99ce3..124609b 100644 --- a/modules/install-guide/pages/_partials/install/CustomSpoke_RecommendedScheme.adoc +++ b/modules/install-guide/pages/_partials/install/CustomSpoke_RecommendedScheme.adoc @@ -24,7 +24,7 @@ For a minimal installation, a 10 GB root partition will be sufficient. However, [NOTE] ==== -The `/` mount point is the top of the Linux Filesystem Hierarchy, and is referred to as the _root file system_, or root. The `/root` directory, sometimes pronounced "pass:attributes[{blank}]_slash-root_pass:attributes[{blank}]", is the home directory for the `root` user. +The `/` mount point is the top of the Linux Filesystem Hierarchy, and is referred to as the _root file system_, or root. The `/root` directory, sometimes pronounced "`pass:attributes[{blank}]_slash-root_pass:attributes[{blank}]`", is the home directory for the `root` user. ==== diff --git a/modules/install-guide/pages/_partials/install/StorageSpoke_BootLoader.adoc b/modules/install-guide/pages/_partials/install/StorageSpoke_BootLoader.adoc index bcfc478..e80ad93 100644 --- a/modules/install-guide/pages/_partials/install/StorageSpoke_BootLoader.adoc +++ b/modules/install-guide/pages/_partials/install/StorageSpoke_BootLoader.adoc @@ -21,7 +21,7 @@ If you are installing Fedora system with more than one disk, you may want to man image::anaconda/StorageSpoke_BootLoader.png[The Selected Disks dialog, displaying all disks selected as installation targets and allowing you to set one of them as a boot device. The boot loader will be installed onto that device.] -In the `Boot` column, a "tick" icon marks one of the devices as the intended boot device. To change the boot device, select a device from the list and click the `Set as Boot Device` button to install the boot loader there instead. Only one device can be set as the boot device. +In the `Boot` column, a "`tick`" icon marks one of the devices as the intended boot device. To change the boot device, select a device from the list and click the `Set as Boot Device` button to install the boot loader there instead. Only one device can be set as the boot device. To decline installation of a new boot loader, select the device currently marked for boot and click the `Do not install bootloader` button. This will remove the tick and ensure [application]*GRUB2* is not installed on any device. diff --git a/modules/install-guide/pages/advanced/Boot_Options.adoc b/modules/install-guide/pages/advanced/Boot_Options.adoc index 1b1c348..1b5a789 100644 --- a/modules/install-guide/pages/advanced/Boot_Options.adoc +++ b/modules/install-guide/pages/advanced/Boot_Options.adoc @@ -10,9 +10,9 @@ You can use multiple options at the same time; in that case, separate them by a There are two basic types of options described in this chapter: -* Options presented as ending with an "equals" sign (`=`) require a value to be specified - they cannot be used on their own. For example, the [option]#inst.vncpassword=# option must also contain a value (in this case, a password). The correct form is therefore [option]#inst.vncpassword=pass:attributes[{blank}]_password_pass:attributes[{blank}]#. On its own, without a password specified, the option is invalid. +* Options presented as ending with an "`equals`" sign (`=`) require a value to be specified - they cannot be used on their own. For example, the [option]#inst.vncpassword=# option must also contain a value (in this case, a password). The correct form is therefore [option]#inst.vncpassword=pass:attributes[{blank}]_password_pass:attributes[{blank}]#. On its own, without a password specified, the option is invalid. -* Options presented without the "pass:attributes[{blank}]`=`pass:attributes[{blank}]" sign do not accept any values or parameters. For example, the [option]#rd.live.check# option forces [application]*Anaconda* to verify the installation media before starting the installation; if this option is present, the check will be performed, and if it is not present, the check will be skipped. +* Options presented without the "`pass:attributes[{blank}]`=`pass:attributes[{blank}]`" sign do not accept any values or parameters. For example, the [option]#rd.live.check# option forces [application]*Anaconda* to verify the installation media before starting the installation; if this option is present, the check will be performed, and if it is not present, the check will be skipped. In addition to the options described in this chapter, the boot prompt also accepts [application]*dracut* kernel options. A list of these options is available as the `dracut.cmdline(7)` man page. @@ -77,7 +77,8 @@ Disk device names may be specified using the following formats: + ** File system UUID, for example `UUID=8176c7bf-04ff-403a-a832-9557f94e61db` + -Non-alphanumeric characters must be represented as `\xpass:attributes[{blank}]_NN_pass:attributes[{blank}]`, where _NN_ is the hexadecimal representation of the character. For example, `\x20` is a white space (""). +// Normally, I would use quotes substitution (https://docs.asciidoctor.org/asciidoc/latest/subs/quotes/), but it can't be used when quoting a single space. See: https://github.com/asciidoctor/asciidoctor/issues/4122 +Non-alphanumeric characters must be represented as `\xpass:attributes[{blank}]_NN_pass:attributes[{blank}]`, where _NN_ is the hexadecimal representation of the character. For example, `\x20` is a white space (“ ”). [option]#inst.stage2=#:: Specifies the location of the installation program runtime image to be loaded. The syntax is the same as in xref:tabl-boot-options-sources[Installation Sources]. This option expects a path to a directory containing a valid `.treeinfo` file; the location of the runtime image will be read from this file if found. If a `.treeinfo` file is not available, [application]*Anaconda* will try to load the image from `LiveOS/squashfs.img`. + diff --git a/modules/install-guide/pages/appendixes/Disk_Partitions.adoc b/modules/install-guide/pages/appendixes/Disk_Partitions.adoc index 4f45ea6..a4484f7 100644 --- a/modules/install-guide/pages/appendixes/Disk_Partitions.adoc +++ b/modules/install-guide/pages/appendixes/Disk_Partitions.adoc @@ -33,7 +33,7 @@ image::partitions/unused-drive.png[Image of an unused disk drive.] [[sect-disk-partitions-file-systems]] === File Systems -To store data on a disk drive, it is necessary to _format_ the disk drive first. Formatting (usually known as "making a _file system_pass:attributes[{blank}]") writes information to the drive, creating order out of the empty space in an unformatted drive. +To store data on a disk drive, it is necessary to _format_ the disk drive first. Formatting (usually known as "`making a _file system_pass:attributes[{blank}]`") writes information to the drive, creating order out of the empty space in an unformatted drive. [[figu-partitions-formatted-drive]] .Disk Drive with a File System @@ -97,11 +97,11 @@ Each partition table entry contains several important characteristics of the par * The points on the disk where the partition starts and ends -* Whether the partition is "active" +* Whether the partition is "`active`" * The partition's type -The starting and ending points define the partition's size and location on the disk. The "active" flag is used by some operating systems' boot loaders. In other words, the operating system in the partition that is marked "active" is booted. +The starting and ending points define the partition's size and location on the disk. The "`active`" flag is used by some operating systems' boot loaders. In other words, the operating system in the partition that is marked "`active`" is booted. The type is a number that identifies the partition's anticipated usage. Some operating systems use the partition type to denote a specific file system type, to flag the partition as being associated with a particular operating system, to indicate that the partition contains a bootable operating system, or some combination of the three. @@ -145,7 +145,7 @@ The single partition in this example is labeled as `DOS`. This label shows the * [[sect-disk-partitions-extended]] === Partitions Within Partitions - An Overview of Extended Partitions -In case four partitions are insufficient for your needs, you can use _extended partitions_ to create up additional partitions. You do this by setting the type of a partition to "Extended". +In case four partitions are insufficient for your needs, you can use _extended partitions_ to create up additional partitions. You do this by setting the type of a partition to "`Extended`". An extended partition is like a disk drive in its own right - it has its own partition table which points to one or more partitions (now called _logical partitions_, as opposed to the four _primary partitions_) contained entirely within the extended partition itself. xref:figu-partitions-extended[Disk Drive With Extended Partition], shows a disk drive with one primary partition and one extended partition containing two logical partitions (along with some unpartitioned free space). @@ -163,7 +163,7 @@ GUID Partition Table (*GPT*) is a newer partitioning scheme based on using Globa *GPT* disks use logical block addressing (LBA) and the partition layout is as follows: -* To preserve backward compatibility with MBR disks, the first sector (*LBA* 0) of *GPT* is reserved for *MBR* data and it is called "protective MBR". +* To preserve backward compatibility with MBR disks, the first sector (*LBA* 0) of *GPT* is reserved for *MBR* data and it is called "`protective MBR`". * The _primary *GPT* header_ begins on the second logical block (*LBA* 1) of the device. The header contains the disk GUID, the location of the primary partition table, the location of the secondary GPT header, and CRC32 checksums of itself and the primary partition table. It also specifies the number of partition entries of the table. @@ -277,7 +277,7 @@ Each step is described further in more detail. [[sect-disk-partitions-compress-data]] ==== Compress Existing Data -As the following figure shows, the first step is to compress the data in your existing partition. The reason for doing this is to rearrange the data such that it maximizes the available free space at the "end" of the partition. +As the following figure shows, the first step is to compress the data in your existing partition. The reason for doing this is to rearrange the data such that it maximizes the available free space at the "`end`" of the partition. [[figu-partitions-compress-data]] .Disk Drive Being Compressed @@ -317,7 +317,7 @@ In the above example, `1` represents before and `2` represents after. [[sect-partitioning-naming-schemes-and-mount-points]] == Partition Naming Schemes and Mount Points -A common source of confusion for users unfamiliar with Linux is the matter of how partitions are used and accessed by the Linux operating system. In DOS/Windows, it is relatively simple: Each partition gets a "drive letter." You then use the correct drive letter to refer to files and directories on its corresponding partition. This is entirely different from how Linux deals with partitions and, for that matter, with disk storage in general. This section describes the main principles of partition naming scheme and the way how partitions are accessed in {PRODUCT}. +A common source of confusion for users unfamiliar with Linux is the matter of how partitions are used and accessed by the Linux operating system. In DOS/Windows, it is relatively simple: Each partition gets a "`drive letter.`" You then use the correct drive letter to refer to files and directories on its corresponding partition. This is entirely different from how Linux deals with partitions and, for that matter, with disk storage in general. This section describes the main principles of partition naming scheme and the way how partitions are accessed in {PRODUCT}. [[sect-disk-partitions-naming-scheme]] === Partition Naming Scheme diff --git a/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc b/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc index bbf09b4..e1d2a38 100644 --- a/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc +++ b/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc @@ -444,7 +444,7 @@ Never specify multipath devices by device names like `mpatha`. Device names such ==== + -Starting with Fedora 25, you can combine multiple ways of specifying storage targets in one command, using the pipe ("pass:attributes[{blank}]`|`pass:attributes[{blank}]") as a delimiter. For example: +Starting with Fedora 25, you can combine multiple ways of specifying storage targets in one command, using the pipe ("`pass:attributes[{blank}]`|`pass:attributes[{blank}]`") as a delimiter. For example: + ---- clearpart --drives=sd*|hd*|vda,/dev/vdc @@ -526,7 +526,7 @@ Never specify multipath devices by device names like `mpatha`. Device names such ==== + -Starting with Fedora 25, you can combine multiple ways of specifying storage targets in one command, using the pipe ("pass:attributes[{blank}]`|`pass:attributes[{blank}]") as a delimiter. For example: +Starting with Fedora 25, you can combine multiple ways of specifying storage targets in one command, using the pipe ("`pass:attributes[{blank}]`|`pass:attributes[{blank}]`") as a delimiter. For example: + ---- ignoredisk --drives=sd*|hd*|vda,/dev/vdc @@ -1312,7 +1312,7 @@ The above will bind the configuration of the device specified by interface name + The above command will create a bond device named `mynetwork` using the `em1` and `em2` interfaces as its slaves. -[command]#--bondopts=#:: A list of optional parameters for a bonded interface, which is specified using the [command]#--bondslaves=# and [command]#--device=# options. Options in this list must be separated by commas ("pass:attributes[{blank}]`,`pass:attributes[{blank}]") or semicolons ("pass:attributes[{blank}]`;`pass:attributes[{blank}]"). If an option itself contains a comma, use a semicolon to separate the options. For example: +[command]#--bondopts=#:: A list of optional parameters for a bonded interface, which is specified using the [command]#--bondslaves=# and [command]#--device=# options. Options in this list must be separated by commas ("`pass:attributes[{blank}]`,`pass:attributes[{blank}]`") or semicolons ("`pass:attributes[{blank}]`;`pass:attributes[{blank}]`"). If an option itself contains a comma, use a semicolon to separate the options. For example: + [subs="quotes, macros"] ---- diff --git a/modules/install-guide/pages/install/Preparing_for_Installation.adoc b/modules/install-guide/pages/install/Preparing_for_Installation.adoc index dfed033..dcca689 100644 --- a/modules/install-guide/pages/install/Preparing_for_Installation.adoc +++ b/modules/install-guide/pages/install/Preparing_for_Installation.adoc @@ -99,9 +99,9 @@ In Windows 8 and 10, the [application]*Fedora Media Writer* launcher will be pla . Open the `.dmg` file, and press and hold the kbd:[Ctrl] key while clicking on the [application]*Fedora Media Writer* application. -. Press "Open" in the pop-up menu. +. Press "`Open`" in the pop-up menu. -. Click the "Open" button in the confirmation dialog, if it appears. +. Click the "`Open`" button in the confirmation dialog, if it appears. === Writing the ISO image to the USB Media. . Select the Fedora Edition you wish to make a bootable USB drive for. @@ -113,7 +113,7 @@ image::fedora_media_writer/main_screen.png[Image of Fedora Media Writer Main Scr + 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. +. Select "`Create Live USB`" to proceed. + [[figu-fedora_media_writer_distro_information_fedora]] .Fedora Media Writer Distro Information