Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed _images/docs/installation/brasero_home.png
Binary file not shown.
Binary file removed _images/docs/installation/brasero_image.png
Binary file not shown.
Binary file removed _images/docs/installation/etcher.gif
Binary file not shown.
Binary file added _images/docs/installation/impression1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/docs/installation/impression2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/docs/installation/impression3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/docs/installation/rufus.png
Binary file not shown.
Binary file added _images/docs/installation/rufus1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/docs/installation/rufus2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/docs/installation/rufus3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/docs/installation/rufus_checksum_icon.png
Binary file not shown.
Binary file removed _images/docs/installation/rufus_disk_icon.png
Binary file not shown.
Binary file removed _images/docs/installation/rufus_hash_selected.png
Binary file not shown.
Binary file removed _images/docs/installation/rufus_select_iso.png
Binary file not shown.
Binary file removed _images/docs/installation/unetbootin.png
Binary file not shown.
Binary file removed _images/docs/installation/windows_image.jpg
Binary file not shown.
112 changes: 84 additions & 28 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,7 @@ Make sure to back your important data up to an external location such as a cloud

## Step-by-step Guide {#choose-operating-system}

<div class="embed">
<iframe src="https://www.youtube-nocookie.com/embed/3KoCDt4fxcM?modestbranding=1&rel=0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

Follow the video above, or select the operating system you are currently using to view tailored installation instructions below.
Follow the guide below, by selecting the operating system you are currently using to view tailored installation instructions below.

<div class="operating-system-choices-container text-center">
<div id="operating-system-choices" class="column linked">
Expand All @@ -58,9 +54,9 @@ Follow the video above, or select the operating system you are currently using t

<div id="install-on-windows" class="slide" markdown="1">

### Verify Your Download {#verify-your-download}
### Verify Your Download (Optional) {#verify-your-download}

Verifying your download is an important step: we generate a "checksum" for elementary OS images and recommend that you verify that your download matches that checksum before trying to install. This ensures that you've received the full, complete download and that it is not corrupted.
Verifying your download is an optional step: We generate a "checksum" for elementary OS images and recommend that you verify that your download matches that checksum before trying to install. This ensures that you've received the full, complete download and that it is not corrupted.
Comment on lines +57 to +59
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should change this. Most people will probably skip this step anyways, but I think it's good to encourage everyone to verify their download


Assuming you downloaded elementary OS to your Windows Downloads folder, open the Command Prompt in Windows and run the following command:

Expand All @@ -79,20 +75,52 @@ If the checksum does not match, you may need to re-download your copy of element

### Creating an Install Drive {#creating-an-installation-medium .clear-float}

To create an elementary OS install drive you'll need a USB flash drive that is at least 4 GB in capacity and an app called "Etcher".
To create an elementary OS install drive you'll need a USB flash drive that is at least 4 GB in capacity and an app called "Rufus". This app is used to create USB stick that your computer can boot from, using .iso file. It works for all kinds of .iso files, not just elementary OS.

<a href="https://balena.io/etcher" class="button suggested-action">Download Etcher</a>
It can be downloaded from Microsoft directly, using the Windows App Store

![etcher steps](images/docs/installation/etcher.gif)
<a href="https://apps.microsoft.com/detail/9pc3h3v7q9ch?hl=en-us&gl=US&ocid=pdpshare" class="button suggested-action">Download Rufus</a>

Open Etcher, then:
**Step by Step Written Instructions:**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like you're using bold styles as headers here, which is not semantically correct


1. Open Rufus
2. Plug in your spare USB flash drive
3. Rufus should automatically detect your USB drive; if not, select the correct drive.
4. Select your downloaded .iso file using the "SELECT" button. (Refer to Picture 1)
5. (Recommended) If your computer is from 2012 or newer, select "GPT" under "Partition scheme"
6. Click the "Start" button.
7. A dialog will appear, keep the default selection to write in "ISO image mode" (Refer to Picture 2)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

compound sentence. Should be period or semicolon

8. Sit back and wait a minute or two
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this is misleading. There should be some action here. Step 7 says to "keep the default selection", but then there's nothing about which button to press, so this seems to imply that I should not press anything and instead wait. This is also inconsistent with directions in other sections which give the action and finish the step with "This make take a moment" instead of making waiting its own separate step

9. Once complete, Rufus will say "READY". (Refer to Picture 3)

Now you're ready to boot from the install drive.

**Step by Step Pictures:**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why we would separate out the pictures from the steps? Why not have these together?


Picture 1: SELECT button and Partition scheme
<img
src="images/docs/installation/rufus1.png"
alt="Buttons to select in the user interface"
width="400"
>


Picture 2: Select ISO image mode
<img
src="images/docs/installation/rufus2.png"
alt="Selecting ISO writing method"
width="400"
>


Picture 3: Finished
<img
src="images/docs/installation/rufus3.png"
alt="Finished writing the image"
width="400"
>

1. Plug in your spare USB flash drive
2. Select your downloaded .iso file using the "Select image" button
3. Etcher should automatically detect your USB drive; if not, select the correct drive
4. Click the "Flash!" button. It may take a moment to get started.

Once complete, continue to boot from the install drive.

### Booting From the Install Drive {#booting-from-the-installation-medium .clear-float}

Expand All @@ -107,9 +135,9 @@ In order to start the installation process, you must boot your computer from the

<div id="install-on-macos" class="slide" markdown="1">

### Verify Your Download {#verify-your-download}
### Verify Your Download (Optional) {#verify-your-download}

Verifying your download is an important step: we generate a "checksum" for elementary OS images and recommend that you verify that your download matches that checksum before trying to install. This ensures that you've received the full, complete download and that it is not corrupted.
Verifying your download is an optional step: We generate a "checksum" for elementary OS images and recommend that you verify that your download matches that checksum before trying to install. This ensures that you've received the full, complete download and that it is not corrupted.

Assuming you downloaded elementary OS to your macOS Downloads folder, open the Terminal app in macOS and run the following command:

Expand All @@ -131,7 +159,6 @@ To create an elementary OS install drive you'll need a USB flash drive that is a

<a href="https://balena.io/etcher" class="button suggested-action">Download Etcher</a>

![etcher steps](images/docs/installation/etcher.gif)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems mistakenly removed?


Open Etcher, then:

Expand Down Expand Up @@ -162,9 +189,9 @@ If your Mac doesn't recognize your elementary OS USB Install Drive in the boot m

<div id="install-on-ubuntu" class="slide" markdown="1">

### Verify Your Download {#verify-your-download}
### Verify Your Download (Optional) {#verify-your-download}

Verifying your download is an important step: we generate a "checksum" for elementary OS images and recommend that you verify that your download matches that checksum before trying to install. This ensures that you've received the full, complete download and that it is not corrupted.
Verifying your download is an optional step: We generate a "checksum" for elementary OS images and recommend that you verify that your download matches that checksum before trying to install. This ensures that you've received the full, complete download and that it is not corrupted.

Running the following command in your terminal:

Expand All @@ -180,21 +207,50 @@ It should produce the output:

### Creating an Install Drive {#creating-an-installation-medium .clear-float}

To create an elementary OS install drive you'll need a USB flash drive that is at least 4 GB in capacity and an app called "Etcher".
To create an elementary OS install drive you'll need a USB flash drive that is at least 4 GB in capacity and an app called "Impression".

<a href="https://balena.io/etcher" class="button suggested-action">Download Etcher</a>
<a href="https://flathub.org/en/apps/io.gitlab.adhami3310.Impression" class="button suggested-action">Download Impression</a>

![etcher steps](images/docs/installation/etcher.gif)
**NOTE:** If you do not have flathub enabled on your computer, refer to the <a href="https://flathub.org/en/setup">flathub setup instructions</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems inconsistent with the previous instructions about the windows app store being above the call to action. I'm also note sure the "NOTE" is necessary here.

Probably should also be consistent with the language "set up" instead of "enabled"


Open Etcher, then:
**Step by Step Written Instructions:**

1. Plug in your spare USB flash drive
2. Select your downloaded .iso file using the "Select image" button
3. Etcher should automatically detect your USB drive; if not, select the correct drive
4. Click the "Flash!" button. It may take a moment to get started.
2. Open the Impression app on your computer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our Rufus instructions just said "Open Rufus". We should be consistent. Also is it necessary to plug in the drive before opening impression? Can we be consistent in our step order?

3. Select your downloaded .iso file using the "Open File..." button (Refer to Picture 1)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure to use ellipsis not three periods

4. Impression should automatically detect your USB drive; if not, select the correct drive (Refer to Picture 2)
5. Click the "Write" button. It may take a moment to get started. (Refer to Picture 3)

Once complete, continue to boot from the install drive.



**Step by Step Pictures:**

Picture 1: "Open File..." button
<img
src="images/docs/installation/impression1.png"
alt="File selection button"
width="400"
>

Picture 2: Select USB drive
<img
src="images/docs/installation/impression2.png"
alt="Drive selection button"
width="400"
>


Picture 3: Writing the image
<img
src="images/docs/installation/impression3.png"
alt="Progress bar showing the iso being written"
width="400"
>



### Booting From the Install Drive {#booting-from-the-installation-medium .clear-float}

In order to start the installation process, you must boot your computer from the install drive.
Expand Down
Loading