Skip to content

Commit

Permalink
small docusaurus and install docs updates (#35)
Browse files Browse the repository at this point in the history
* updated docusaurus settings
* updated install docs
  • Loading branch information
zackbradys authored Oct 13, 2024
1 parent 28fc0ef commit 31643ba
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 22 deletions.
22 changes: 16 additions & 6 deletions docs/introduction/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Installation

## Overview

Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our [GitHub Release](https://github.com/hauler-dev/hauler/releases) page.
Hauler is a purpose built to be a single binary with no prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our [GitHub Release](https://github.com/hauler-dev/hauler/releases) page.

## Supported Architectures

Expand All @@ -25,15 +25,25 @@ Hauler is a purpose built to be a single binary with no specific prerequistes, d
curl -sfL https://get.hauler.dev | bash

# install specific release
curl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash
curl -sfL https://get.hauler.dev | HAULER_VERSION=1.1.0 bash

# install at different directory
curl -sfL https://get.hauler.dev | HAULER_INSTALL_DIR=/usr/bin bash

# install with debug mode
curl -sfL https://get.hauler.dev | HAULER_DEBUG=true bash
```

### Homebrew

```bash
# installs latest release
# install latest release
brew tap hauler-dev/homebrew-tap
brew install hauler

# install specific release
brew tap hauler-dev/homebrew-tap
brew install [email protected]
```

### Windows
Expand All @@ -47,13 +57,13 @@ brew install hauler
### Linux/Darwin

```bash
# set the hauler version (i.e. "1.0.0")
# set the hauler version (i.e. HAULER_VERSION=1.1.0)
export vHauler=HAULER_VERSION

# set the specific platform (i.e. "linux")
# set the specific platform (i.e. PLATFORM=linux)
export platform=PLATFORM

# set the specific arch (i.e. "amd64")
# set the specific arch (i.e. ARCH=amd64)
export arch=ARCH

curl -sOL https://github.com/hauler-dev/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz
Expand Down
4 changes: 3 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,13 @@ const sidebars = {
type: 'category',
label: 'Guides & References',
description: 'Reference Guides Documentation for Hauler',
collapsed: true,
collapsed: false,
items: [
'guides-references/overview',
'guides-references/cluster-images',
'guides-references/carbide-customers',
'guides-references/container-runtimes',
'guides-references/bootstraping-utilities',
'guides-references/hauler-manifests',
'guides-references/hauler-content',
'guides-references/hauler-collections',
Expand Down
9 changes: 1 addition & 8 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,7 @@ function HomepageHeader() {
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container" >
<h1 className="hero__title">
Rancher Government &nbsp;

<span className='nasa'>
H<span class="nasa-red">A</span>ULER
</span>
</h1>
{/* <h1 className="hero__title">{siteConfig.title}</h1> */}
<h1 className="hero__title">{siteConfig.title}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
Expand Down
22 changes: 16 additions & 6 deletions versioned_docs/version-1.1.x/introduction/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Installation

## Overview

Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our [GitHub Release](https://github.com/hauler-dev/hauler/releases) page.
Hauler is a purpose built to be a single binary with no prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our [GitHub Release](https://github.com/hauler-dev/hauler/releases) page.

## Supported Architectures

Expand All @@ -25,15 +25,25 @@ Hauler is a purpose built to be a single binary with no specific prerequistes, d
curl -sfL https://get.hauler.dev | bash

# install specific release
curl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash
curl -sfL https://get.hauler.dev | HAULER_VERSION=1.1.0 bash

# install at different directory
curl -sfL https://get.hauler.dev | HAULER_INSTALL_DIR=/usr/bin bash

# install with debug mode
curl -sfL https://get.hauler.dev | HAULER_DEBUG=true bash
```

### Homebrew

```bash
# installs latest release
# install latest release
brew tap hauler-dev/homebrew-tap
brew install hauler

# install specific release
brew tap hauler-dev/homebrew-tap
brew install [email protected]
```

### Windows
Expand All @@ -47,13 +57,13 @@ brew install hauler
### Linux/Darwin

```bash
# set the hauler version (i.e. "1.0.0")
# set the hauler version (i.e. HAULER_VERSION=1.1.0)
export vHauler=HAULER_VERSION

# set the specific platform (i.e. "linux")
# set the specific platform (i.e. PLATFORM=linux)
export platform=PLATFORM

# set the specific arch (i.e. "amd64")
# set the specific arch (i.e. ARCH=amd64)
export arch=ARCH

curl -sOL https://github.com/hauler-dev/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz
Expand Down
4 changes: 3 additions & 1 deletion versioned_sidebars/version-1.1.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,13 @@
"type": "category",
"label": "Guides & References",
"description": "Reference Guides Documentation for Hauler",
"collapsed": true,
"collapsed": false,
"items": [
"guides-references/overview",
"guides-references/cluster-images",
"guides-references/carbide-customers",
"guides-references/container-runtimes",
"guides-references/bootstraping-utilities",
"guides-references/hauler-manifests",
"guides-references/hauler-content",
"guides-references/hauler-collections"
Expand Down

0 comments on commit 31643ba

Please sign in to comment.