cleaned up and fixed docs

hauler-dev · Nov 12, 2023 · 466140b · 466140b
1 parent dfa8d5f
commit 466140b
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,8 @@ npx docusaurus --version
 ### Deploy Locally
 
 ```bash
-npm run start # this will open your default browser to http://localhost:3000
+# this will open your default browser to http://localhost:3000
+npm run start
 ```
 
 ## Creating Content
@@ -28,11 +29,11 @@ npm run start # this will open your default browser to http://localhost:3000
 
 ## Publishing Content
 
-This docs site is served using github-pages. There is an [action](.github/workflows/deploy.yml) that will trigger upon commit to the `main` branch and deploy the new build to https://rancherfederal.github.io/hauler-docs.
+This docs site is served using github-pages. There is an [action](.github/workflows/deploy.yml) that will trigger upon commit to the `main` branch and deploy the new build to https://hauler.dev (https://rancherfederal.github.io/hauler-docs).
 
 ## Contributing
 
-- Fork this repository
-- Make your changes
-- Commit changes and reference the Issue
-- Submit Pull Request with changes
+- Fork this Repository
+- Make your Changes
+- Commit changes and Reference the Issue
+- Submit Pull Request with Changes
diff --git a/docs/introduction/install.md b/docs/introduction/install.md
@@ -18,7 +18,7 @@ Hauler is a purpose built to be a single binary with no specific prerequistes or
 
 ## Installation Steps
 
-### Linux/Darwin Install
+### Linux/Darwin
 
 ```bash
 # install latest release
@@ -28,14 +28,31 @@ curl -sfL https://get.hauler.dev | sh
 curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.0 sh
 ```
 
-### Windows Install
+### Windows
 
 ```bash
 # coming soon
 ```
 
-### Homebrew Install
+### Homebrew
 
 ```bash
 # coming soon
 ```
+
+## Manual Installation Steps
+
+```bash
+# set the hauler version (i.e. "0.4.0")
+export vHauler=HAULER_VERSION
+
+# set the specific platform (i.e. "linux")
+export platform=PLATFORM
+
+# set the specific arch (i.e. "amd64")
+export arch=ARCH
+
+curl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz
+tar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz
+sudo mv hauler /usr/bin/hauler
+```
diff --git a/docs/introduction/quickstart.md b/docs/introduction/quickstart.md
@@ -15,7 +15,9 @@ curl -sfL https://get.hauler.dev | sh
 
 ## Example Use of Hauler
 
-### Add Content to the Hauler Store (via the Command Line)
+### Add Content to the Hauler Store
+
+#### Using the Command Line:
 
 ```bash
 # add a image: neuvector/scanner:latest
@@ -31,7 +33,7 @@ hauler store add chart rancher --repo https://releases.rancher.com/server-charts
 hauler store add file https://get.rke2.io --name install.sh
 ```
 
-### Add Content to the Hauler Store (via a Manifest)
+#### Using a Hauler Manifest:
 
 ```bash
 hauler store sync --files hauler-manfiest.yaml

diff --git a/versioned_docs/version-0.4.0/introduction/install.md b/versioned_docs/version-0.4.0/introduction/install.md
@@ -18,7 +18,7 @@ Hauler is a purpose built to be a single binary with no specific prerequistes or
 
 ## Installation Steps
 
-### Linux/Darwin Install
+### Linux/Darwin
 
 ```bash
 # install latest release
@@ -28,14 +28,31 @@ curl -sfL https://get.hauler.dev | sh
 curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.0 sh
 ```
 
-### Windows Install
+### Windows
 
 ```bash
 # coming soon
 ```
 
-### Homebrew Install
+### Homebrew
 
 ```bash
 # coming soon
 ```
+
+## Manual Installation Steps
+
+```bash
+# set the hauler version (i.e. "0.4.0")
+export vHauler=HAULER_VERSION
+
+# set the specific platform (i.e. "linux")
+export platform=PLATFORM
+
+# set the specific arch (i.e. "amd64")
+export arch=ARCH
+
+curl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz
+tar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz
+sudo mv hauler /usr/bin/hauler
+```
diff --git a/versioned_docs/version-0.4.0/introduction/quickstart.md b/versioned_docs/version-0.4.0/introduction/quickstart.md
@@ -15,7 +15,9 @@ curl -sfL https://get.hauler.dev | sh
 
 ## Example Use of Hauler
 
-### Add Content to the Hauler Store (via the Command Line)
+### Add Content to the Hauler Store
+
+#### Using the Command Line:
 
 ```bash
 # add a image: neuvector/scanner:latest
@@ -31,7 +33,7 @@ hauler store add chart rancher --repo https://releases.rancher.com/server-charts
 hauler store add file https://get.rke2.io --name install.sh
 ```
 
-### Add Content to the Hauler Store (via a Manifest)
+#### Using a Hauler Manifest:
 
 ```bash
 hauler store sync --files hauler-manfiest.yaml