updates/upgrades for hauler v1.1.0 (#30)

* updated github actions
* removed references to rancherfederal
* upgraded docusaurus and dependencies
* updated command outputs
* added versioned docs
* fixed typos
* updated based on feedback
* updated dependencies
* updated packages/dependencies
* overhauled docs layout
* last bit of docs additions

.github/workflows/deploy.yaml

@@ -1,42 +1,44 @@
-name: Deploy to GitHub Pages
+name: Build and Deploy Docs
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
-    # Review gh actions docs if you want to further define triggers, paths, etc
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
-  workflow_dispatch:
 
 jobs:
-  deploy:
-    name: Deploy to GitHub Pages
+  build-and-deploy:
+    name: Build and Deploy Docs
     runs-on: ubuntu-latest
+    timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v3
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Set Up Node
+        uses: actions/setup-node@v4
         with:
           node-version: 18
           cache: npm
 
-      - name: Install dependencies
+      - name: Install Dependencies
         run: npm ci
-      - name: Build website
+
+      - name: Build Docs
         run: npm run build
 
-      # Popular action to deploy to GitHub Pages:
-      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
-      - name: Deploy to GitHub Pages
+      - name: Deploy Docs to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          # Build output to publish to the `gh-pages` branch:
           publish_dir: ./build
           cname: docs.hauler.dev
-          # The following lines assign commit authorship to the official
-          # GH-Actions bot for deploys to `gh-pages` branch:
-          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
-          # The GH actions bot is used by default if you didn't specify the two fields.
-          # You can swap them out with your own user credentials.
           user_name: github-actions[bot]
-          user_email: 41898282+github-actions[bot]@users.noreply.github.com
+          user_email: github-actions[bot]@users.noreply.github.com

Makefile

@@ -26,6 +26,6 @@ build:
 serve:
 	npm run serve
 
-# clear build outputs
-clear:
+# clean build outputs
+clean:
 	npm run clear && rm -rf node_modules

README.md

@@ -7,12 +7,15 @@
 ### Installing Dependencies (docusaurus)
 
 ```bash
-git clone https://github.com/rancherfederal/hauler-docs
+git clone https://github.com/hauler-dev/hauler-docs
 cd hauler-docs
 
 # install docusaurus & dependencies from package.json
-npm install # make sure you are in the root of the dir containing `package.json`
-# yarn install # if npm install did not work
+# make sure you are in the root directory
+npm install
+
+# if npm install did not work
+# yarn install
 
 # test the installation
 npx docusaurus --version
@@ -21,7 +24,7 @@ npx docusaurus --version
 ### Deploy Locally
 
 ```bash
-# this will open your default browser to http://localhost:3000
+# this will build the docs and open your default browser to http://localhost:3000
 npm run start
 ```
 
@@ -31,7 +34,7 @@ npm run start
 
 ## 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://hauler.dev (https://rancherfederal.github.io/hauler-docs).
+This docs site is served using `GitHub Pages`. There is an [action](.github/workflows/deploy.yaml) that will trigger upon commit to the `main` branch and deploy the new build to https://docs.hauler.dev (previously https://hauler.dev).
 
 ## Contributing
 

docs/core-concepts.md

@@ -50,4 +50,4 @@ In Hauler's terminology, `content` refers to artifacts such as **container image
 
 ### Declarative Content
 
-While manually adding content to `Hauler` is an easy way to get started, there is a more sustainable approach... `Hauler` provides a declarative and programmatic approach by allowing operators to define `content` within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your `hauls`. Check it out [here](guides-references/manifests.md)!
+While manually adding content to `Hauler` is an easy way to get started, there is a more sustainable approach... `Hauler` provides a declarative and programmatic approach by allowing operators to define `content` within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your `hauls`. Check it out [here](guides-references/hauler-manifests.md)!

docs/feedback.md

@@ -6,4 +6,4 @@ sidebar_label: Feedback
 
 Feedback is **critical** to us to continue to improve `Hauler` and accelerate your mission.
 
-For any issues, concerns, or questions, please open an issue: https://github.com/rancherfederal/hauler/issues
+For any issues, concerns, or questions, please open an issue: https://github.com/hauler-dev/hauler/issues

docs/guides-references/bootstraping-utilities.md

@@ -0,0 +1,7 @@
+---
+title: Bootstrapping Utilities
+description: Bootstrapping Utilities Documentation
+sidebar_label: Bootstrapping Utilities
+---
+
+Bootstrapping Utilities documentation are pending a future release!

docs/guides-references/carbide-customers.md

@@ -4,11 +4,13 @@ description: RGS Carbide Customers Documentation
 sidebar_label: RGS Carbide Customers
 ---
 
-For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within `Hauler`.
+For all supported customers of Rancher Government, under the umbrella of Rancher Government Carbide, there is included addon functionality within `Hauler`.
 
-`Hauler` has the the ability to reference `Collections` from the Carbide Secured Registry (CSR). `Hauler` is built to allow operators to fetch, store, package, and distribute content and collections, but most operators may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available `product` flags.
+`Hauler` has the the ability to reference `Collections` from various registeries, including the `Carbide Secured Registry (CSR)`.
 
-Please see the **[Carbide Documentation](https://rancherfederal.github.io/carbide-docs/docs/intro)** for easily fetching, packing, and distributing Carbide with the `hauler store sync --products <product>=<product-version>`. Please know that we are actively working to improve this workflow.
+To better understand this workflow, `Hauler` is built to allow operators to fetch, store, package, and distribute various artifacts, but most operators may be unsure of what to fetch, store, package, and distribute, and that is where our supported customers are able to leverage predefined manifests, known as `Collections`, via the `--products` flag, through the `Carbide Secured Registry (CSR)`, for all of Rancher Government products and solutions.
 
-- [Connected Environments](https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images)
-- [Disconnected Environments](https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images)
+Please see the **[Carbide Documentation](http://docs.ranchercarbide.dev)** for easily fetching, packing, and distributing Carbide with the `hauler store sync --products <product>=<product-version>`. Please know that we are actively working to improve this workflow and your feedback is appreciated!
+
+- Carbide Docs for [Connected Environments](https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images)
+- Carbide Docs for [Disconnected Environments](https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images)