Skip to content

Commit 3952b7e

Browse files
author
Julien Kassar
committed
Update documentation
1 parent 6cce447 commit 3952b7e

File tree

9 files changed

+27
-17
lines changed

9 files changed

+27
-17
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Supported Docker versions with HBM.
3636

3737
## Getting Started & Documentation
3838

39-
All documentation is available on the [Harbormaster website](http://harbormaster.io/docs/hbm/).
39+
All documentation is available on the [Harbormaster website](http://harbormaster.io/docs/hbm/overview/).
4040

4141
## User Feedback
4242

docs/getstarted/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ github_edit: "https://github.com/kassisol/hbm/edit/master/docs/getstarted/index.
1313

1414
## Install
1515

16-
Refer to the [page](../installation/index.md) specific to your Linux distribution.
16+
Refer to the [page](../installation/overview.md) specific to your Linux distribution.
1717

1818
## Configure
1919

docs/installation/binary.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ menu:
99
docs:
1010
parent: "hbm_install"
1111
weight: 110
12-
github_edit: "https://github.com/kassisol/hbm/edit/master/docs/install/binary.md"
12+
github_edit: "https://github.com/kassisol/hbm/edit/master/docs/installation/binary.md"
1313
toc: true
1414
---
1515

1616
## Get the HBM binary
1717

1818
You can download a specific version. To get the list of stable
19-
release version numbers from GitHub, view the `harbormaster/hbm`
19+
release version numbers from GitHub, view the `kassisol/hbm`
2020
[releases page](https://github.com/kassisol/hbm/releases).
2121

2222

@@ -33,7 +33,7 @@ https://github.com/kassisol/hbm/releases/download/x.x.x/hbm
3333
#### Install the Linux binary
3434

3535
After downloading, HBM requires this binary to be installed in your host's `$PATH`.
36-
For example, to install the binaries in `/usr/local/sbin`:
36+
For example, to install the binary in `/usr/local/sbin`:
3737

3838
```bash
3939
$ mv hbm /usr/local/sbin/
@@ -70,8 +70,8 @@ server:
7070
# killall hbm
7171
```
7272

73-
Then follow the [regular installation steps](#get-the-linux-binaries).
73+
Then follow the [regular installation steps](#get-the-linux-binary).
7474

7575
## Next steps
7676

77-
Continue with the [Admin Guide](../admin/index.md).
77+
Continue with the [Admin Guide](../admin/overview.md).

docs/installation/linux/el.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu:
99
docs:
1010
parent: "hbm_linux"
1111
weight: -4
12-
github_edit: "https://github.com/kassisol/hbm/edit/master/docs/install/linux/el.md"
12+
github_edit: "https://github.com/kassisol/hbm/edit/master/docs/installation/linux/el.md"
1313
toc: true
1414
---
1515

docs/installation/linux/rancheros.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu:
99
docs:
1010
parent: "hbm_linux"
1111
weight: -4
12-
github_edit: "https://github.com/kassisol/hbm/edit/master/docs/install/linux/rancheros.md"
12+
github_edit: "https://github.com/kassisol/hbm/edit/master/docs/installation/linux/rancheros.md"
1313
toc: true
1414
---
1515

docs/installation/overview.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: "About HBM"
2+
title: "Install HBM"
33
linktitle: "Overview"
4-
description: "HBM"
4+
description: "Lists the installation methods"
55
keywords: [ "hbm", "about" ]
66
date: "2017-01-27"
77
url: "/docs/hbm/install/overview/"
@@ -13,3 +13,14 @@ github_edit: "https://github.com/kassisol/hbm/edit/master/docs/install/overview.
1313
toc: true
1414
---
1515

16+
HBM is supported on Linux. Installation instructions are available for the following:
17+
18+
## On Linux
19+
* [EL7](linux/el.md)
20+
* [RancherOS](linux/rancheros.md)
21+
22+
If your linux distribution is not listed above, don't give up yet. To try out HBM on a distribution that is not listed above, go here: [Installation from binary](binary.md).
23+
24+
## Where to go after installing
25+
* [About HBM](../overview.md)
26+
* [Support](https://github.com/kassisol/hbm/issues/)

docs/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,18 @@ By default Harbormaster plugin prevents from executing commands and certains par
4545

4646
### Installation guides
4747

48-
The [installation section](installation/index.md) will show you how to install HBM
48+
The [installation section](installation/overview.md) will show you how to install HBM
4949
on a variety of platforms.
5050

5151
### Admin guide
5252

5353
To learn about HBM in more detail and to answer questions about usage and
54-
implementation, check out the [Admin Guide](admin/index.md).
54+
implementation, check out the [Admin Guide](admin/overview.md).
5555

5656
## Release notes
5757

5858
A summary of the changes in each release in the current series can now be found
59-
on the separate [Release Notes page](http://harbormaster.io/docs/release-notes)
59+
on the separate [Release Notes page](https://github.com/kassisol/hbm/releases)
6060

6161
## Licensing
6262

docs/reference/_index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
22
title: "HBM reference"
33
description: "HBM reference"
4-
keywords: [ "HBM" ]
4+
keywords: [ "HBM", "reference" ]
55
date: "2017-01-27"
66
menu:
77
docs:
88
identifier: "hbm_ref"
99
parent: "hbm_use"
1010
weight: 70
1111
---
12-
13-
* [Command line reference](commandline/index.md)

docs/reference/commandline/version.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ date: "2017-01-27"
66
menu:
77
docs:
88
parent: "hbm_cli"
9+
github_edit: "https://github.com/kassisol/hbm/edit/master/docs/reference/commandline/version.md"
910
---
1011

1112
```markdown

0 commit comments

Comments
 (0)