merge pull request #6 from zackbradys/main

updated docs for new installation steps and minor fixes
hauler-dev · Nov 16, 2023 · 3a07611 · 3a07611
2 parents 2474d05 + 466140b
commit 3a07611
Show file tree

Hide file tree

Showing 13 changed files with 117 additions and 51 deletions.
diff --git a/Makefile b/Makefile
@@ -12,6 +12,11 @@ install:
 test:
 	npm run start
 
+# cut new version of hauler-docs
+# make version v=0.0.0
+version:
+	npm run docusaurus docs:version ${v}
+
 # build and compile hauler-docs
 build:
 	npm run build

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/guides-references/intro.md → docs/guides-references/overview.md b/docs/guides-references/intro.md → docs/guides-references/overview.md
@@ -1,14 +1,17 @@
 ---
-title: Introduction
-description: Reference Guides Intro Documentation for Hauler
-sidebar_label: Introduction
+title: Overview
+description: Reference Guides Overview Documentation for Hauler
+sidebar_label: Overview
 ---
 
+Additional Overview Documentation pending a future release!
+
 ## Hauler Guides & Reference Documentation
 
 |                     Guide or Reference Documentation                      |                      Description                       |
 | :-----------------------------------------------------------------------: | :----------------------------------------------------: |
-|         [Cluster Images](/docs/guides-references/cluster-images)          | Fetch Images on a Cluster and add to the Hauler Store  |
+|         [Content Validation](/docs/guides-references/validation)          |        Validate and Verify Content with Hauler         |
+|         [Cluster Images](/docs/guides-references/cluster-images)          |     Create a Hauler Store from Images on a Cluster     |
 | [Hauler Collections](/docs/guides-references/hauler-collections/overview) |        Detailed Overview of Hauler Collections         |
 |     [Hauler Content](/docs/guides-references/hauler-content/overview)     |          Detailed Overview of Hauler Content           |
 |    [Hauler Command Line](/docs/guides-references/command-line/hauler)     | Detailed Overview of the Hauler Command Line Interface |
diff --git a/docs/guides-references/validation.md b/docs/guides-references/validation.md
@@ -0,0 +1,7 @@
+---
+title: Content Validation
+description: Content Validation Documentation
+sidebar_label: Content Validation
+---
+
+Content Validation Documentation pending a future release!
diff --git a/docs/introduction/install.md b/docs/introduction/install.md
@@ -10,14 +10,38 @@ Hauler is a purpose built to be a single binary with no specific prerequistes or
 
 ## Supported Architectures
 
-| Base Platfor |    Architecture     |                  Latest Release                   |
-| :----------: | :-----------------: | :-----------------------------------------------: |
-|    Linux     | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
-|    Darwin    | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
-|    Windows   | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
+| Base Platform |    Architecture     |                  Latest Release                   |
+| :-----------: | :-----------------: | :-----------------------------------------------: |
+|     Linux     | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
+|    Darwin     | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
+|    Windows    | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
 
 ## Installation Steps
 
+### Linux/Darwin
+
+```bash
+# install latest release
+curl -sfL https://get.hauler.dev | sh
+
+# install specific release
+curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.0 sh
+```
+
+### Windows
+
+```bash
+# coming soon
+```
+
+### Homebrew
+
+```bash
+# coming soon
+```
+
+## Manual Installation Steps
+
 ```bash
 # set the hauler version (i.e. "0.4.0")
 export vHauler=HAULER_VERSION
@@ -28,7 +52,7 @@ export platform=PLATFORM
 # set the specific arch (i.e. "amd64")
 export arch=ARCH
 
-curl -#OL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz
+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
@@ -6,23 +6,18 @@ sidebar_label: Quickstart
 
 Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:
 
-:::tip
-
-Please note that we will be using the `linux` and `amd64` binary for Hauler. If you are using a different platform or architecture, take a look at the complete [installation documentation](/docs/introduction/install).
-
-:::
-
 ## Quick Installation
 
 ```bash
-curl -#OL https://github.com/rancherfederal/hauler/releases/download/v0.4.0/hauler_0.4.0_linux_amd64.tar.gz
-tar -xf hauler_0.4.0_linux_amd64.tar.gz
-sudo mv hauler /usr/bin/hauler
+# install latest release
+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
@@ -38,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/docusaurus.config.js b/docusaurus.config.js
@@ -114,7 +114,7 @@ const config = {
               },
               {
                 label: 'Reference Guides',
-                to: '/docs/guides-references/intro',
+                to: '/docs/guides-references/overview',
               },
             ],
           },

diff --git a/sidebars.js b/sidebars.js
@@ -23,7 +23,8 @@ const sidebars = {
       description: 'Guides and References Docs for Hauler',
       collapsed: false,
       items: [
-        'guides-references/intro',
+        'guides-references/overview',
+        'guides-references/validation',
         'guides-references/cluster-images',
         {
           type: 'category',

diff --git a/.../version-0.4.0/guides-references/intro.md → ...rsion-0.4.0/guides-references/overview.md b/.../version-0.4.0/guides-references/intro.md → ...rsion-0.4.0/guides-references/overview.md
@@ -1,14 +1,17 @@
 ---
-title: Introduction
-description: Reference Guides Intro Documentation for Hauler
-sidebar_label: Introduction
+title: Overview
+description: Reference Guides Overview Documentation for Hauler
+sidebar_label: Overview
 ---
 
+Additional Overview Documentation pending a future release!
+
 ## Hauler Guides & Reference Documentation
 
 |                     Guide or Reference Documentation                      |                      Description                       |
 | :-----------------------------------------------------------------------: | :----------------------------------------------------: |
-|         [Cluster Images](/docs/guides-references/cluster-images)          | Fetch Images on a Cluster and add to the Hauler Store  |
+|         [Content Validation](/docs/guides-references/validation)          |        Validate and Verify Content with Hauler         |
+|         [Cluster Images](/docs/guides-references/cluster-images)          |     Create a Hauler Store from Images on a Cluster     |
 | [Hauler Collections](/docs/guides-references/hauler-collections/overview) |        Detailed Overview of Hauler Collections         |
 |     [Hauler Content](/docs/guides-references/hauler-content/overview)     |          Detailed Overview of Hauler Content           |
 |    [Hauler Command Line](/docs/guides-references/command-line/hauler)     | Detailed Overview of the Hauler Command Line Interface |
diff --git a/versioned_docs/version-0.4.0/guides-references/validation.md b/versioned_docs/version-0.4.0/guides-references/validation.md
@@ -0,0 +1,7 @@
+---
+title: Content Validation
+description: Content Validation Documentation
+sidebar_label: Content Validation
+---
+
+Content Validation Documentation pending a future release!
diff --git a/versioned_docs/version-0.4.0/introduction/install.md b/versioned_docs/version-0.4.0/introduction/install.md
@@ -10,14 +10,38 @@ Hauler is a purpose built to be a single binary with no specific prerequistes or
 
 ## Supported Architectures
 
-| Base Platfor |    Architecture     |                  Latest Release                   |
-| :----------: | :-----------------: | :-----------------------------------------------: |
-|    Linux     | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
-|    Darwin    | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
-|    Windows   | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
+| Base Platform |    Architecture     |                  Latest Release                   |
+| :-----------: | :-----------------: | :-----------------------------------------------: |
+|     Linux     | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
+|    Darwin     | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
+|    Windows    | `amd64` and `arm64` | https://github.com/rancherfederal/hauler/releases |
 
 ## Installation Steps
 
+### Linux/Darwin
+
+```bash
+# install latest release
+curl -sfL https://get.hauler.dev | sh
+
+# install specific release
+curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.0 sh
+```
+
+### Windows
+
+```bash
+# coming soon
+```
+
+### Homebrew
+
+```bash
+# coming soon
+```
+
+## Manual Installation Steps
+
 ```bash
 # set the hauler version (i.e. "0.4.0")
 export vHauler=HAULER_VERSION
@@ -28,7 +52,7 @@ export platform=PLATFORM
 # set the specific arch (i.e. "amd64")
 export arch=ARCH
 
-curl -#OL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz
+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
@@ -6,23 +6,18 @@ sidebar_label: Quickstart
 
 Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:
 
-:::tip
-
-Please note that we will be using the `linux` and `amd64` binary for Hauler. If you are using a different platform or architecture, take a look at the complete [installation documentation](/docs/introduction/install).
-
-:::
-
 ## Quick Installation
 
 ```bash
-curl -#OL https://github.com/rancherfederal/hauler/releases/download/v0.4.0/hauler_0.4.0_linux_amd64.tar.gz
-tar -xf hauler_0.4.0_linux_amd64.tar.gz
-sudo mv hauler /usr/bin/hauler
+# install latest release
+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
@@ -38,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_sidebars/version-0.4.0-sidebars.json b/versioned_sidebars/version-0.4.0-sidebars.json
@@ -20,7 +20,8 @@
       "description": "Guides and References Docs for Hauler",
       "collapsed": false,
       "items": [
-        "guides-references/intro",
+        "guides-references/overview",
+        "guides-references/validation",
         "guides-references/cluster-images",
         {
           "type": "category",