Cleaning up setup guide (#178)

* Clean up error doc

* Clean up top-level readme, trailing spaces only

* OS top level READMEs

* Cleanup environment page

* Cleanup apt page

* Line breaks

* Cleanup Homebrew pages

* Fixed apt page command structure

* Cleanup Git pages

* Up through Tree pages

* Cleanup Ohmyzsh

* Finish ohmyzsh and node pages

* Cleanup live-server pages

* eslint and folder structure pages cleaned up

* Cleaned up vscode pages

* Verify pages and finishing touches

* Ohmyzsh typos

Author: kassiebradshaw

README.md

@@ -8,7 +8,7 @@ You do not need to understand what is happening in each step of this process. Ge
 
 *NOTE: During this process, you will be required to download a few files. For this setup process please **right-click** on links to **open in a new tab** when asked to download and install.  This is so you don't lose your place.*
 
-Get started by selecting the appropriate starting point below. 
+Get started by selecting the appropriate starting point below.
 
 ## Software Development Courses
 
@@ -19,7 +19,7 @@ Begin by selecting your operating system:
 - Configure [Windows 10](./system-setup/windows/windows-10.md)
 - Configure [Windows 11](./system-setup/windows/windows-11.md)
 
-## Ops and Cybersecurity Courses 
+## Ops and Cybersecurity Courses
 
 - Configure [all operating systems](./ops-setup/1-network.md)
 

error/error.md

@@ -2,8 +2,8 @@
 
 Getting a weird error or something unexpected?
 
-The frist step is to double-check that you are following the instructions carefully. It's ok to try again. 
+The first step is to double-check that you are following the instructions carefully. It's ok to try again.
 
-If you continue to get an error, check your course syllabus for how to get in touch with your instructor or TAs. 
+If you continue to get an error, check your course syllabus for how to get in touch with your instructor or TAs.
 
-Don't hesitate to reach out! Many issues can be resolved very quickly by those who have been through this process before. Most people need a little assistance with this process at one point or another. 
+Don't hesitate to reach out! Many issues can be resolved very quickly by those who have been through this process before. Most people need a little assistance with this process at one point or another.

system-setup/1-environment.md

@@ -1,9 +1,5 @@
 # Backup Your Terminal/Shell Environment
 
-This section will talk about how to update the Terminal's look and feel, as well as how to edit files using the command line editor, `nano`
-
-At the end of this guide, we will add some color to your command line, and your command line will be formatted for development.
-
 ## Backing up files
 
 The first thing we'll do is backup your existing terminal setup.
@@ -22,11 +18,13 @@ Make back ups of the files listed below. You may get a `No such file or director
 
 ## Windows & Linux Users Only
 
-```bash
-sudo apt-get install zsh
-```
+Run the following command:
+
+- `sudo apt-get install zsh`
+
+After installing, run: `zsh`
 
-After installing, type `zsh`. Zsh will ask you to choose some configuration. We will do this later by installing `oh-my-zsh`. Chose option 0 to create the config file (prevent this message to show again).
+Zsh will ask you to choose some configuration. We will do this later by installing `oh-my-zsh`. Chose option 0 to create the config file (prevent this message from showing again).
 
 Now, let's move on to getting our development applications installed.
 

system-setup/2-apt.md

@@ -4,12 +4,12 @@
 
 For some things on your system, we will be using `apt` to install applications. The first thing we'll want to do is get that up to date with all of the latest versions and information
 
-**OPEN YOUR TERMINAL** and let's get started!
-
-1. Type `sudo apt-get update`.
+1. Run the command: `sudo apt-get update`
    - Provide your password, when prompted (***Note:*** *You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes.*)
-1. Once that is complete, type `sudo apt-get upgrade`. Press `y` when prompted.
-1. Once that is done, type `sudo apt autoremove`. This will remove any packages that are no longer needed.
+1. Once that is complete, run: `sudo apt-get upgrade`
+   - Press `y` when prompted.
+1. Once that is complete, run: `sudo apt autoremove`
+   - This will remove any packages that are no longer needed.
 1. Install the "Build Essentials" kit with this command: `sudo apt-get install build-essential`
 
 ---

system-setup/linux/1-environment.md

@@ -1,19 +1,17 @@
 # Backup Your Terminal/Shell Environment
 
-This section will talk about how to update the Terminal's look and feel, as well as how to edit files using the command line editor, `nano`
-
-At the end of this guide, we will add some color to your command line, and your command line will be formatted for development.
-
 ## Backing up files
 
 The first thing we'll do is backup your existing terminal setup.
 
-There are a lot of ways that your terminal can be set up determined by different configuration files.
+There are a lot of ways that your terminal can be set up, determined by different configuration files.
 
 We want to remove the old ways so we can start with a clean slate.
 
 Make back ups of the files listed below. You may get a `No such file or directory` error for some of them. That's ok.
 
+Run these commands:
+
 - `mv ~/.bashrc .bashrc.bak`
 - `mv ~/.bash_profile .bash_profile.bak`
 - `mv ~/.profile .profile.bak`
@@ -22,11 +20,15 @@ Make back ups of the files listed below. You may get a `No such file or director
 
 ## Install Z Shell
 
-```bash
-sudo apt-get install zsh
-```
+Run the following command:
+
+- `sudo apt-get install zsh`
+
+After installing, run the command:
+
+- `zsh`
 
-After installing, type `zsh`. Zsh will ask you to choose some configuration. We will do this later by installing `oh-my-zsh`. Chose option 0 to create the config file (prevent this message to show again).
+Zsh will ask you to choose some configuration. We will do this later by installing `oh-my-zsh`. Chose option 0 now to create the config file (prevent this message from showing again).
 
 Now, let's move on to getting our development applications installed.
 

system-setup/linux/10-vscode.md

@@ -2,7 +2,9 @@
 
 Now it's time to install VSCode Text Editor, a sophisticated text editor for code, markup, and prose.
 
-> **Follow the below instructions in order**, paying attention to any notes specific to Windows or Mac, depending on your operating system.
+> **Follow the below instructions in order**, paying attention to any notes specific to your operating system.
+
+---
 
 ## Get Started
 
@@ -11,14 +13,17 @@ Now it's time to install VSCode Text Editor, a sophisticated text editor for cod
 - If this window displays during set up, be sure the following boxes are selected
 ![VSCode](../vscode.png)
 
-### Install Additional VSCode Extensions
+---
+
+## Install Required VSCode Extensions
 
 We'll now be adding some functionality to your new code editor by installing a number of extensions.
 
-- You can open VSCode through your terminal using `code .`
+- Re-open your terminal and run the command:
+  - `code .`
 - On the bottom left hand side you will see a settings ("gear") icon.
-- Click this, then click "Extensions".
-- A side-bar will slide out and at the top you can search for the listed extensions below, and click the green 'Install' button for each:
+- Click this, then select "Extensions".
+- A side-bar will slide out and at the top you can search for the listed extensions below, and click the 'Install' button for each:
   - liveserver
   - ESLint
   - markdownlint

system-setup/linux/11-verify.md

@@ -1,27 +1,34 @@
 # Verify Your Setup Part 1
 
-> By the time you’ve completed the guide, you should be able to run the following commands in your terminal and see the expected output. Your versions may be slightly different than what is listed here due to recent updates.
+> By the time you’ve completed the guide, you should be able to run the following commands in your terminal and see the expected output. Your versions may be slightly higher than what is listed here due to recent updates.
+
+Run these commands and compare them with the expected output.
 
 - `code --version`
-  - `1.64.2`
+  - Expected output: `1.64.2`
 - `git --version`
-  - `git version 2.34.1`
+  - Expected output: `git version 2.34.1`
 - `node --version`
-  - `v17.31.1`
+  - Expected output: `v17.8.0`
 - `npm --version`
-  - `8.3.0`
+  - Expected output: `8.3.0`
 - `eslint --version`
-  - `v8.1.0`
+  - Expected output: `v8.1.0`
 - `tree --version`
-  - `tree v2.0.1 (c) 1996 - 2018 ...`
-- `git config --list` should contain at least the following:
+  - Expected output: `tree v2.0.1 (c) 1996 - 2022 ...`
+- `git config --list`
+  - Should contain at least the following:
   - `user.name=YOUR NAME`
   - `user.email=YOUR EMAIL`
   - `core.editor=code --wait`
   - `init.defaultbranch=main`
-  - Type the letter `q` to exit the config screen and return to the previous screen.
+  - (Type the letter `q` to exit the config screen and return to the previous screen.)
 - `code .`
-  - should open VS Code with your current folder contents
+  - Should open VS Code with your current folder contents
+
+If any of the above commands do not give you the expected output, get [assistance](../../error/error.md).
+
+---
 
 ## Verify Your Setup Part 2
 
@@ -31,7 +38,7 @@ Run the following command
 curl -Ls https://bit.ly/3qMWhbE | bash
 ```
 
-You should get a successful message. If you do not see `By gum, you've done it!`, look at the output from the steps in part 1 to begin troubleshooting. Get TA assistance as necessary.
+You should get a successful message. If instead you see `Something went wrong!`, look at the output carefully, and retry the steps in part 1 to begin troubleshooting. Get [assistance](../../error/error.md) as necessary.
 
 ---
 

system-setup/linux/2-apt.md

@@ -1,14 +1,22 @@
-# Installing and Updating the Linux App Manager
+# APT
 
-For some things on your system, we will be using `apt` to install applications. The first thing we'll want to do is get that up to date with all of the latest versions and information
+For some things on your system, we will be using Advanced Package Tool, referred to as `apt`, to install applications. The first thing we'll want to do is get that up to date with all of the latest versions and information.
 
-**OPEN YOUR UBUNTU TERMINAL** and let's get started!
+---
+
+## Installing and Updating the Linux App Manager (APT)
 
-1. Type `sudo apt-get update`.
-   - Provide your password, when prompted (***Note:*** *You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes.*)
-1. Once that is complete, type `sudo apt-get upgrade`. Press `y` when prompted.
-1. Once that is done, type `sudo apt autoremove`. This will remove any packages that are no longer needed.
-1. Install the "Build Essentials" kit with this command: `sudo apt-get install build-essential`
+1. Run the command:
+   - `sudo apt-get update`
+      - Provide your password, when prompted (**_Note:_** _You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes._)
+1. Once that is complete, run:
+   - `sudo apt-get upgrade`
+      - Press `y` when prompted.
+1. Once that is complete, run:
+   - `sudo apt autoremove`
+      - This will remove any packages that are no longer needed.
+1. Install the "Build Essentials" kit with this command:
+   - `sudo apt-get install build-essential`
 
 ---
 

system-setup/linux/3-homebrew.md

@@ -1,76 +1,103 @@
-# Install "Homebrew"
+# Homebrew
 
 Homebrew is a tool that simplifies installing applications on your machine. Think of it like an app store for your computer.
 
 ---
 
 ## Verify if Homebrew is already installed
 
-- In your terminal, run: `brew --version`
-  - _If output is similar to:_ `Homebrew 3.4.11`
-    - Run: `brew update` to get latest updates
-    - Move on to [next page](./4-git.md)
-  - _If output is not similar to the above_, continue with instructions on this page.
+**_If this is your first time going through the setup guide on your current machine, skip this "Verify" section and move on to the "Install" section below_**
+
+In your terminal, run:
+
+- `brew --version`
+
+> **IF** the output is similar to:
+>
+> ```text
+> Homebrew 3.4.11
+> ```
+>
+> Run the command:
+>
+> - `brew update`
+>
+> to get latest updates, and move on to the [next page](./4-git.md)
+>
+> ---
+> **else if** the output is not similar to the above:
+>
+> Continue with instructions on this page.
 
 ---
 
-In your terminal, enter the following command:
+## Install Homebrew
 
-- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
-- You will be prompted several times along the way. Enter your password when prompted, accept all the defaults, say "Yes" if prompted. (**_Note:_** _You will not have any visual feedback on your screen as you type. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes._)
-- Once the main installation finishes (could take up to 30 minutes), **look at the output at the bottom of your terminal**. You may see an arrow pointing to "Next Steps" line with 2 commands.
-
-![Homebrew No Next Steps example](../../images/homebrew-next-steps.png)
-
-- Enter those commands, one at a time in your terminal - they should produce no errors, and do not produce success messages.
-
-- Then enter these commands, one at a time in your terminal - they should produce no errors, and do not produce success messages:
-  - `test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)`
-  - `test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)`
-
-Once the installation has completed, **run:**
-
-`brew doctor`
+In your terminal, run the following command:
 
-**if** return output is:
-
-```bash
-Your system is ready to brew
-```
-
-**or** return output is:
-
-```text
-Please note that these warnings are just used to help the Homebrew maintainers
-with debugging if you file an issue. If everything you use Homebrew for is
-working fine: please don't worry or file an issue; just ignore this. Thanks!
-```
-
-**then run:**
+- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
 
-`brew update`
+You will be prompted several times along the way.
 
-**else if** return output is:
+Enter your password when prompted, accept all the defaults, say "Yes" if prompted. (**_Note:_** _You will not have any visual feedback on your screen as you type your password. It is protecting your password by not displaying ANYTHING at all to the screen, but it is registering your key strokes._)
 
-```bash
-brew: command not found
-```
+Once the main installation finishes (could take up to 30 minutes), **look at the output at the bottom of your terminal**. You may see an arrow pointing to **"Next Steps:"** instructions. They would look similar to the image below.
 
-**then** run these commands
+![Homebrew No Next Steps example](../../images/homebrew-next-steps.png)
 
-1. `echo 'export BREW_HOME="/home/linuxbrew/.linuxbrew/bin"' >> $HOME/.zshrc`
-1. `echo 'export PATH="$PATH:$BREW_HOME"' >> $HOME/.zshrc`
-1. `reset`
+Run the commands shown in your terminal one at a time - they should produce no errors, and do not produce success messages.
+
+Then run these commands, one at a time in your terminal - they should produce no errors, and do not produce success messages:
+
+- `test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)`
+- `test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)`
+
+Once that step is completed, **run:**
+
+- `brew doctor`
+
+> **IF** the return output is:
+>
+> ```text
+> Your system is ready to brew
+> ```
+>
+> **OR** the return output is:
+>
+> ```text
+> Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue. If everything you use Homebrew for is working fine: please don't worry or file an issue; just ignore this. Thanks!
+> ```
+>
+> **then** run the command:
+>
+> - `brew update`
+>
+> ---
+> **else if** the return output is:
+>
+> ```text
+> brew: command not found
+> ```
+>
+> **then** run these commands:
+>
+> - `echo 'export BREW_HOME="/home/linuxbrew/.linuxbrew/bin"' >> $HOME/.zshrc`
+> - `echo 'export PATH="$PATH:$BREW_HOME"' >> $HOME/.zshrc`
+> - `reset`
+>
+> and start the sequence over from the `brew doctor` step one more time
+
+**If `brew doctor` still fails to run, [click here](../../error/error.md) and do not continue with the following steps until you have Homebrew properly installed**
 
-> **If `brew update` still fails to run, [click here](../../error/error.md) and do not continue with the following steps until you have Homebrew properly installed**
+---
 
-## Install "gcc"
+## Install GCC
 
 In order for Homebrew to install other applications, it needs a tool called **gcc** to assist itself.
 
 Run this command in your terminal:
 
-`brew install gcc`
+- `brew install gcc`
 
 When that completes, you will be returned to the command prompt and can move on to the next steps.