#139 Touchups
Merged 4 years ago by pbokoc. Opened 4 years ago by chase9.
fedora-docs/ chase9/quick-docs master  into  master

@@ -1,9 +1,6 @@ 

  [id='proc_creating-and-using-live-cd']

  = Creating and using live CD

  

- #FIXME# Needs modularization

- 

- 

  [[getting-started]]

  == Getting started

  
@@ -133,13 +130,6 @@ 

  

  Replace `_filename.iso_` with the name of your created Live CD image and `_qemu-system-x86_64_` with an appropriate qemu binary for the target system, e.g. `qemu-system-i386`.

  

- 

- [id='using-your-new-live-image']

- == Using your new live image

- 

- You can http://docs.fedoraproject.org/readme-burning-isos/[burn your image directly to a CD or a DVD] if it fits, or you can link:#proc_creating-and-using-live-usb[write it to a USB stick].

- 

- 

  [id='live-image-media-verification']

  == Live image media verification

  

@@ -9,7 +9,7 @@ 

  [id='using-fedora-media-writer']

  == Using Fedora Media Writer

  

- The official and supported tool to create a Fedora USB stick is the *Fedora Media Writer* utility, which was formerly known as *LiveUSB Creator*. To learn more about this application and how to use it, refer to the https://docs.fedoraproject.org/{MAJOROSVER}/install-guide/install/Preparing_for_Installation.html[Preparing for Installation] chapter of the Fedora Installation Guide.

+ The official and supported tool to create a Fedora USB stick is the *Fedora Media Writer* utility, which was formerly known as *LiveUSB Creator*. To learn more about this application and how to use it, refer to the https://docs.fedoraproject.org/en-US/fedora/f{MAJOROSVER}/install-guide/install/Preparing_for_Installation/#sect-preparing-boot-media[Preparing for Installation] chapter of the Fedora Installation Guide.

  

  

  [IMPORTANT]
@@ -48,7 +48,7 @@ 

  

  IMPORTANT: This method will destroy all data on the USB stick _if the `--format` parameter is passed_.

  

- The `livecd-iso-to-disk` method is slightly less reliable than Fedora Media Writer and can be used reliably only from within Fedora: it does not work in Windows or OS X, and is not supported (and will usually fail) in non-Fedora distributions. However, it supports three advanced features which FMW does not include:

+ The `livecd-iso-to-disk` method is slightly less reliable than Fedora Media Writer and can be used reliably only from within Fedora: it does not work in Windows or macOS, and is not supported (and will usually fail) in non-Fedora distributions. However, it supports three advanced features which FMW does not include:

  

  . You may use a _non-destructive_ method to create the stick, meaning existing files on the stick will not be destroyed. This is less reliable than the _destructive_ write methods, and should be used only if you have no stick you can afford to wipe.

  . On live images, you can include a feature called a _persistent overlay_, which allows changes made to persist across reboots. You can perform updates just like a regular installation to your hard disk, except that kernel updates require manual intervention and overlay space may be insufficient. Without a _persistent overlay_, the stick will return to a fresh state each time it is booted.
@@ -124,7 +124,7 @@ 

  This method will destroy all data on the USB stick. If you need a non-destructive write method, to preserve existing data on your USB stick, and/or support for `data persistence`, you can use the `livecd-iso-to-disk` utility on Fedora.

  ====

  

- This method directly writes the image to the USB stick much like xref:creating-and-using-a-live-installation-image.adoc#using-fedora-media-writer[Fedora Media Writer] or GNOME Disk Utility, but uses a command line utility named `dd`. Like the other _direct write_ methods, it will destroy all data on the stick and does not support any of the advanced features like data persistence, but it is a very reliable method. The `dd` tool is available on most Unix-like operating systems, including Linux distributions and OS X, and a Windows port is available. This may be your best method if you cannot use xref:creating-and-using-a-live-installation-image.adoc#using-fedora-media-writer[Fedora Media Writer] or GNOME Disk Utility, or just if you prefer command line utilities and want a simple, quick way to write a stick.

+ This method directly writes the image to the USB stick much like xref:creating-and-using-a-live-installation-image.adoc#using-fedora-media-writer[Fedora Media Writer] or GNOME Disk Utility, but uses a command line utility named `dd`. Like the other _direct write_ methods, it will destroy all data on the stick and does not support any of the advanced features like data persistence, but it is a very reliable method. The `dd` tool is available on most Unix-like operating systems, including Linux distributions and macOS, and a Windows port is available. This may be your best method if you cannot use xref:creating-and-using-a-live-installation-image.adoc#using-fedora-media-writer[Fedora Media Writer] or GNOME Disk Utility, or just if you prefer command line utilities and want a simple, quick way to write a stick.

  

  . Identify the name of the USB drive partition. If using this method on Windows, with the port linked above, the `dd --list` command should provide you with the correct name.

  . *Unmount all mounted partition from that device*. This is very important, otherwise the written image might get corrupted. You can umount all mounted partitions from the device with `umount /dev/sdX*`, where `_X_` is the appropriate letter, e.g. `umount /dev/sdc*`.
@@ -140,7 +140,7 @@ 

  

  

  [id='unetbootin']

- == Using UNetbootin for Windows, OS X, and Linux

+ == Using UNetbootin for Windows, macOS, and Linux

  

  [WARNING]

  ====

modules/ROOT/pages/_partials/proc_installing-fedora-on-a-raspberry-pi-for-macos-users.adoc modules/ROOT/pages/_partials/proc_installing-fedora-on-a-raspberry-pi-for-apple-osx-users.adoc
file renamed
+5 -5
@@ -8,20 +8,20 @@ 

  // * Title: = Doing procedure A

  

  // The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.

- [id='installing-fedora-on-a-raspberry-pi-for-apple-osx-users_{context}']

+ [id='installing-fedora-on-a-raspberry-pi-for-macos-users_{context}']

  // The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.

- = Installing Fedora on a Raspberry Pi for Apple OS X users

+ = Installing Fedora on a Raspberry Pi for macOS users

  // Start the title of a procedure module with a verb, such as Creating or Create. See also _Wording of headings_ in _The IBM Style Guide_.

  

  include::{partialsdir}/attributes.adoc[]

  

- This procedure shows Apple OS X users how to add Fedora ARM to a microSD for use with a Raspberry Pi.

+ This procedure shows macOS users how to add Fedora ARM to a microSD for use with a Raspberry Pi.

  

  ._Prerequisites_

  

  * Raspberry Pi Model B, version 2 or 3.

  * A microSD Card (16 GB or larger).

- * A computer running Apple OS X.

+ * A computer running macOS.

  * SD card reader.

  * A Fedora ARM image from: link:https://arm.fedoraproject.org/[].

  * File-decompression software (such as link:https://theunarchiver.com/[The Unarchiver desktop application] or link:https://theunarchiver.com/command-line[The Unarchiver command-line tools]).
@@ -39,7 +39,7 @@ 

  $ unar Fedora-Server-armhfp-{MAJOROSVER}-1.1-sda.raw.xz

  ----

  

- . Follow the instructions provided by the Raspberry Pi foundation for writing an image to a microSD card from Apple OS X: link:https://www.raspberrypi.org/documentation/installation/installing-images/mac.md[Raspberry Pi Foundation: Installing operating system images on Mac OS].

+ . Follow the instructions provided by the Raspberry Pi foundation for writing an image to a microSD card from macOS: link:https://www.raspberrypi.org/documentation/installation/installing-images/mac.md[Raspberry Pi Foundation: Installing operating system images on Mac OS].

  +

  [NOTE]

  ====

@@ -27,7 +27,7 @@ 

  ** For Fedora users, see: <<installing-fedora-on-a-raspberry-pi-using-the-fedora-arm-installer_{context}>>.

  ** For users of other Linux distributions, see: <<installing-fedora-on-a-raspberry-pi-for-linux-users_{context}>>.

  ** For Microsoft Windows users, see: <<installing-fedora-on-a-raspberry-pi-for-microsoft-windows-users_{context}>>.

- ** For Apple OS X users, see: <<installing-fedora-on-a-raspberry-pi-for-apple-macos-users_{context}>>.

+ ** For macOS users, see: <<installing-fedora-on-a-raspberry-pi-for-macos-users_{context}>>.

  

  * If you try to use Fedora on a Raspberry Pi 1, Raspberry Pi Zero, or a Raspberry Pi model A, you will receive the rainbow display. This occurs because your Raspberry Pi is not supported (ARMv6 SoCs architectures are not supported).

  

@@ -2,8 +2,6 @@ 

  :context: creating-an-using-a-live-installation-image

  = Creating and using a live installation image

  

- include::{partialsdir}/unreviewed-message.adoc[]

- 

  include::{partialsdir}/proc_downloading-fedora.adoc[leveloffset=+1]

  

  include::{partialsdir}/proc_creating-and-using-live-usb.adoc[leveloffset=+1]

file modified
+1 -5
@@ -1,8 +1,6 @@ 

  [[chap-dnf]]

  = Using the DNF software package manager

  

- include::{partialsdir}/unreviewed-message.adoc[]

- 

  DNF is a software package manager that installs, updates, and removes packages on Fedora and is the successor to YUM (Yellow-Dog Updater Modified).

  DNF makes it easy to maintain packages by automatically checking for dependencies and determines the actions required to install packages.

  This method eliminates the need to manually install or update the package, and its dependencies, using the `rpm` command.
@@ -43,7 +41,7 @@ 

  

  * `reinstall` - reinstalls the currently installed package.

  

- * `update/upgrade` - checks the repositories for newer packages and updates them.

+ * `upgrade` - checks the repositories for newer packages and updates them.

  

  For more DNF commands refer to the man pages by typing `man dnf` at the command-line, or link:http://dnf.readthedocs.io/en/latest/command_ref.html[DNF Read The Docs]

  
@@ -90,6 +88,4 @@ 

  

  . http://dnf.readthedocs.org/en/latest/command_ref.html[DNF Command Reference]

  

- . http://dnf.baseurl.org/[DNF blog]

- 

  . https://github.com/rpm-software-management/dnf/wiki[DNF wiki]

@@ -20,7 +20,6 @@ 

  :context: rpi

  // The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.

  include::{partialsdir}/attributes.adoc[]

- include::{partialsdir}/unreviewed-message.adoc[]

  

  The link:https://www.raspberrypi.org[Raspberry Pi] is a credit card-sized ARM based single board computer (SBC).

  The Raspberry Pi Model B versions 2 and 3 are supported for Fedora 25 or newer, without any requirement of third party kernels or scripts to adjust offical images.
@@ -37,15 +36,15 @@ 

  * A USB keyboard and USB mouse.

  * SD card reader.

  * A microSD Card (16 GB or larger).

- * A computer running Microsoft Windows, Apple OS X, or Linux.

+ * A computer running Microsoft Windows, macOS, or Linux.

  * A Fedora ARM image from: link:https://arm.fedoraproject.org/[].

  

- The procedure for installing Fedora ARM on a microSD in preparation for using Fedora on a Raspberry Pi depends on your computers' operating system (Microsoft Windows, Apple OS X, or Linux).

+ The procedure for installing Fedora ARM on a microSD in preparation for using Fedora on a Raspberry Pi depends on your computers' operating system (Microsoft Windows, macOS, or Linux).

  

  * For Fedora users, see: <<installing-fedora-on-a-raspberry-pi-using-the-fedora-arm-installer_{context}>>.

  * For users of other Linux distributions, see: <<installing-fedora-on-a-raspberry-pi-for-linux-users_{context}>>.

  * For Microsoft Windows users, see: <<installing-fedora-on-a-raspberry-pi-for-microsoft-windows-users_{context}>>.

- * For Apple OS X users, see: <<installing-fedora-on-a-raspberry-pi-for-apple-osx-users_{context}>>.

+ * For macOS users, see: <<installing-fedora-on-a-raspberry-pi-for-macos-users_{context}>>.

  

  // The following include statements pull in the module files that comprise the assembly. Include any combination of concept, procedure, or reference modules required to cover the user story. You can also include other assemblies.

  
@@ -57,7 +56,7 @@ 

  

  include::{partialsdir}/proc_installing-fedora-on-a-raspberry-pi-for-microsoft-windows-users.adoc[leveloffset=+1]

  

- include::{partialsdir}/proc_installing-fedora-on-a-raspberry-pi-for-apple-osx-users.adoc[leveloffset=+1]

+ include::{partialsdir}/proc_installing-fedora-on-a-raspberry-pi-for-macos-users.adoc[leveloffset=+1]

  

  include::{partialsdir}/proc_booting-fedora-on-a-raspberry-pi-for-the-first-time.adoc[leveloffset=+1]

  

  • Renamed Apple OS X to macOS
  • Fixed some broken links
  • Removed some extraneous/broken information
  • DNF blog no longer exists
  • ‘Using new Live Image’ is extraneous since it’s already covered at length in the previous sections

Also, is there a variable for the users locale? The fedora docs now include locale in the URL so I used en-US. I'm not sure if this is discouraged.

Probably worth leaving {MAJOROSVER} here instead of hardcoding it to 30?

We'll have to check the locale thing, I'm not sure either.

Thanks very much! Looks very good apart from the one or two comments I made.

A cosmetic suggestion, but not a blocker: for the sake of useful git logs, would it be possible to break this one commit in to multiple? The macOS changes could be one commit, and the broken links could be another. "Touchups" doesn't immediately tell anyone what is being done.

Here's one of many posts on keeping commit-messages useful: https://chris.beams.io/posts/git-commit/

Metadata Update from @ankursinha:
- Pull-request tagged with: improvement, needs changes, needs committer review

4 years ago

rebased onto 57b1061

4 years ago

Hi ankursinha, I apologize for my poor commits. I split it into several more descriptive commits, so hopefully that's acceptable. I also changed the 30 to use {MAJOROSVER}.

I note in my commit about Live USB that I was confused about the modularization warning at the top of the Live CD section. If we could resolve that, I believe we could remove the unreviewed warning from the installation page.

@chase9 hi, I don't know where that FIXME came from but I really don't think it needs to be modularized at this point. Can you please remove that line and the unreviewed warning? I'll merge the PR after that. Thanks!

Metadata Update from @jflory7:
- Pull-request untagged with: needs committer review

4 years ago

1 new commit added

  • Remove remaining unreviewed messages from installation page
4 years ago

@chase9 hi, I don't know where that FIXME came from but I really don't think it needs to be modularized at this point. Can you please remove that line and the unreviewed warning? I'll merge the PR after that. Thanks!

Done!

Metadata Update from @jflory7:
- Pull-request untagged with: needs changes
- Pull-request tagged with: needs committer review
- Request assigned

4 years ago

Pagure is having some issues right now, I'll merge when I can.

Pull-Request has been merged by pbokoc

4 years ago