Merge pull request #7 from ProfessionalLinuxUsersGroup/fix-contributing-title

fix: Update title to match course name

Author: kolkhis

src/contributing.md

@@ -1,7 +1,7 @@
 <div class="flex-container">
         <img src="https://github.com/ProfessionalLinuxUsersGroup/img/blob/main/Assets/Logos/ProLUG_Round_Transparent_LOGO.png?raw=true" width="64" height="64"></img>
     <p>
-        <h1>Contributing to the ProLUG Linux Systems Security Course Book</h1>
+        <h1>Contributing to the ProLUG Linux Automation Engineering Course Book</h1>
     </p>
 </div>
 
@@ -128,7 +128,7 @@ Pull requests with substantial merge conflicts may be rejected.
 You can do this from the GitHub web UI easily with the `Sync Fork` button. If you want to do this from the terminal, you can add a new `git remote` called `upstream`.
 
 ```bash
-git remote add upstream https://github.com/ProfessionalLinuxUsersGroup/psc.git
+git remote add upstream https://github.com/ProfessionalLinuxUsersGroup/pcae.git
 ```
 
 Then, to sync your local fork with the original repo, do a `git pull` from the `upstream` remote.
@@ -157,22 +157,22 @@ visibility and collaboration before merging changes.
 
 ### Create a Fork
 
-Go to the [original repository link](https://github.com/ProfessionalLinuxUsersGroup/psc).
+Go to the [original repository link](https://github.com/ProfessionalLinuxUsersGroup/pcae).
 Click on "Fork" on the top right.
 Now you'll have your own version of the repository that you can clone.
 
 ```bash
-git clone [email protected]:YOUR_USERNAME/psc.git
+git clone [email protected]:YOUR_USERNAME/pcae.git
 # Or, with https:
-git clone https://github.com/YOUR_USERNAME/psc.git
+git clone https://github.com/YOUR_USERNAME/pcae.git
 ```
 
 ### Clone the Fork to your Local Machine
 
 Then you'll need to clone your fork down to your local machine in order to work on it.
 
 ```bash
-git clone [email protected]:yourname/psc.git
+git clone [email protected]:yourname/pcae.git
 ```
 
 ### Create a New Branch
@@ -289,7 +289,7 @@ for free, so there is only one person who is able to merge pull requests at the
 
 ### Create a Pull Request
 
-Now you'll be able to go to the [original repository link](https://github.com/ProfessionalLinuxUsersGroup/psc) and go to the "Pull Requests" tab and create a new pull request.
+Now you'll be able to go to the [original repository link](https://github.com/ProfessionalLinuxUsersGroup/pcae) and go to the "Pull Requests" tab and create a new pull request.
 Select your branch `unit1-worksheet`, and create a description and mention an issue by number (e.g., `#5`).
 
 ## Supporting Material
@@ -298,11 +298,11 @@ Select your branch `unit1-worksheet`, and create a description and mention an is
 
 Below are links to the necessary materials to build out the course templates:
 
-- Look over the [template pages wiki](https://github.com/ProfessionalLinuxUsersGroup/psc/wiki), or directly here:
-  - Pages: [intro](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/intro.md),
-    [bonus](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/ub.md),
-    [lab](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/ulab.md),
-    [worksheet](https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/ref/uws.md)
+- Look over the [template pages wiki](https://github.com/ProfessionalLinuxUsersGroup/pcae/wiki), or directly here:
+  - Pages: [intro](https://github.com/ProfessionalLinuxUsersGroup/pcae/blob/main/ref/intro.md),
+    [bonus](https://github.com/ProfessionalLinuxUsersGroup/pcae/blob/main/ref/ub.md),
+    [lab](https://github.com/ProfessionalLinuxUsersGroup/pcae/blob/main/ref/ulab.md),
+    [worksheet](https://github.com/ProfessionalLinuxUsersGroup/pcae/blob/main/ref/uws.md)
 
 Ancillary unit videos provided by Scott:
 

src/development.md

@@ -11,15 +11,15 @@ are provided below. These guidelines are by no means a requirement or the only
 set of procedures to locally develop on this project.
 
 The examples, code, and commands provided below were developed using such
-technologies as Ansible, containers, bash scripts, and more.
+technologies as containers, bash scripts, and more.
 
 ## Build Dependencies
 
 ---
 
-The ProLUG Security Course (psc) utilizes [mdBook](https://github.com/rust-lang/mdBook)
-(markdown Book), a friendly and popular markdown utility that quickly exports
-files and web structures for documentation or general website use cases.
+The ProLUG Linux Administration Course (pcae) utilizes [mdBook](https://github.com/rust-lang/mdBook)
+(markdown Book), a friendly and popular markdown utility that quickly exports static web files for
+documentation or general website use cases.
 
 Utilizing mdBook this course then deploys the exported web structure to a
 [Git Pages workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages) and runner that then produces an easily navigable website.
@@ -35,97 +35,69 @@ Below is the current workflow that deploys the Git Page for the course:
 To achieve this deployment locally the following environment and dependencies are
 required:
 
-<dl>
-    <dt>1. A localhost, this could be a container, virtual machine, or local machine</dt>
-    <dt>2. The following packages installed on such machine:</dt>
-    <dd>- httpd or apache</dd>
-    <dd>- git</dd>
-    <dd>- gcc</dd>
-    <dd>- rust</dd>
-    <dd>- cargo</dd>
-    <dt>3. And a clone of a ProLUG repository</dt>
-</dl>
+1. A localhost, this could be a container, virtual machine, or local machine
+2. The following packages installed on such machine:
 
-## Building, Deploying, and Developing Locally
-
----
-
-Below is a set of scripts and Ansible-Playbooks that can quickly achieve this
-environment in an automated fashion. They are only designed to "standup" these
-machines, they are otherwise unintelligent and will not manage or cleanup
-environments if things go awry.
-
-### Ansible-Playbook
-
-<https://github.com/ProfessionalLinuxUsersGroup/psc/blob/main/src/assets/deploy/ansible-playbook.yml>
-
-To use this playbook, your machine(s)/containers must be configured correctly for Ansible.
-If you don't know the requirements to administer a machine via Ansible documentation
-has been provided below.
-
-<div class = warning>
-This playbook attempts to install and initialize dependencies based on APT and DNF package managers only.
-</div>
+   - httpd or apache
+   - git
+   - mdBook binary
 
-Getting started with Ansible:  
-<https://docs.ansible.com/ansible/latest/getting_started/index.html>
+3. And a clone of a ProLUG repository
 
-### Bash Script
-
-Many of these commands assume a root user.
-
-Export and execute this script to your machine/container.
-
-<div class=warning>
-
-Dependencies can total over ~500MB compressed and 1-2GB unpackaged or more.
+## Building, Deploying, and Developing Locally
 
-Debian containers/machines will require building many of these packages from
-source or adding additional repositories as Debian has a far slower package
-version adoption rate for stability, thus is not recommended for deploying mdBook.
+---
 
-</div>
+Below is a set of scripts that can quickly achieve this environment in an automated fashion.
 
-These scripts will take up to 5-7 minutes to download the necessary dependencies
-and compile mdBook depending on the machine/container's capabilities.
+These commands assume a `root` user. This script will update and upgrade host packages to
+their latest versions, install git, curl, tar, gzip, grep and their dependencies if they aren't present,
+attempt to pull down the latest fully compiled `mdbook` binary from the official mdBook GitHub repository, boot
+up the local web server, process and produce the necessary .html files from the pcae source files, deploy
+the website and necessary cleanup operations.
 
-Tested with Rocky 9 and Ubuntu 24.04 Containers.
+Outside of system packages all files will be localized to the `/root/pcae` directory on the container or machine.
 
 APT frontends:
 
 ```bash
-#!/usr/bin/env bash
-apt-get update
-apt-get -y install apache2 git gcc rustc-1.80 cargo-1.80
-cargo-1.80 install --locked [email protected]
+#!/bin/bash
+apt-get -y install apache2 git curl tar gzip grep
+cd && git clone https://github.com/ProfessionalLinuxUsersGroup/pcae && cd $HOME/pcae
+VERSION=$(curl -sL https://github.com/rust-lang/mdBook/releases/latest | grep -Po -m 1 'v(?:\d\.){2}\d+')
+curl -sLO "https://github.com/rust-lang/mdBook/releases/download/${VERSION}/mdbook-${VERSION}-x86_64-unknown-linux-gnu.tar.gz"
+tar xfz mdbook-${VERSION}-x86_64-unknown-linux-gnu.tar.gz
+rm -f mdbook-${VERSION}-x86_64-unknown-linux-gnu.tar.gz
 systemctl enable --now apache2
-cd && git clone https://github.com/ProfessionalLinuxUsersGroup/psc
-echo 'PATH=$PATH:~/.cargo/bin/' | tee -a ~/.profile
-export PATH=$PATH:~/.cargo/bin/ && echo $PATH | grep cargo
-cd ~/psc && mdbook build -d /var/www/html
+$PWD/mdbook build -d /var/www/html
 systemctl restart apache2
+unset VERSION
 ```
 
 DNF frontends:
 
 ```bash
-#!/usr/bin/env bash
-dnf update
-dnf install -y httpd git gcc rust cargo
-cargo install --locked mdbook
+#!/bin/bash
+dnf install -y httpd git curl tar gzip grep
+cd && git clone https://github.com/ProfessionalLinuxUsersGroup/pcae && cd $HOME/pcae
+VERSION=$(curl -sL https://github.com/rust-lang/mdBook/releases/latest | grep -Po -m 1 'v(?:\d\.){2}\d+')
+curl -sLO "https://github.com/rust-lang/mdBook/releases/download/${VERSION}/mdbook-${VERSION}-x86_64-unknown-linux-gnu.tar.gz"
+tar xfz mdbook-${VERSION}-x86_64-unknown-linux-gnu.tar.gz
+rm -f mdbook-${VERSION}-x86_64-unknown-linux-gnu.tar.gz
 systemctl enable --now httpd
-cd && git clone https://github.com/ProfessionalLinuxUsersGroup/psc
-echo 'PATH=$PATH:~/.cargo/bin/' | tee -a ~/.bash_profile
-export PATH=$PATH:~/.cargo/bin/ && echo $PATH | grep cargo
-cd ~/psc && mdbook build -d /var/www/html
+$PWD/mdbook build -d /var/www/html
 systemctl restart httpd
+unset VERSION
 ```
 
+The ProLUG Linux Administration Course website should now be available from your
+web browser either at http://localhost or its designated IP address.
+
 #### From here you can use such commands from your localhost to implement changes:
 
 ```bash
-cd {working psc directory} #for example: /root/psc or ~/psc
-mdbook build -d /var/www/html
+cd {working pcae directory} #for example: /root/pcae or ~/pcae
+$HOME/pcae/mdbook build -d /var/www/html
 systemctl restart {httpd or apache}
 ```
 
@@ -141,15 +113,15 @@ From there you should be able to see any changes you have made are reflected.
 these commands will need to utilize absolute paths.
 
 ```bash
-scp {working directory}/{targeted document} {TARGET_IP}:/root/psc/src/{targeted document}
-ssh {TARGET_IP} "cd /root/psc && ~/.cargo/bin/mdbook build -d /var/www/html && systemctl restart httpd"
+scp {working directory}/{targeted document} {TARGET_IP}:/root/pcae/src/{targeted document}
+ssh {TARGET_IP} "cd /root/pcae && /root/pcae/mdbook build -d /var/www/html && systemctl restart httpd"
 ```
 
 An example of the workflow after making changes:
 
 ```bash
-scp src/development.md 172.16.15.8:/root/psc/src/
-ssh 172.16.15.8 "cd /root/psc && ~/.cargo/bin/mdbook build -d /var/www/html && systemctl restart httpd"
+scp src/development.md 172.16.15.8:/root/pcae/src/
+ssh 172.16.15.8 "cd /root/pcae && /root/pcae/mdbook build -d /var/www/html && systemctl restart httpd"
 ```
 
 <img src="./assets/images/flow.png"></img>