Skip to content

Commit

Permalink
Update documentation front matter
Browse files Browse the repository at this point in the history
  • Loading branch information
Julien Kassar committed Mar 29, 2018
1 parent 9e3064e commit e366872
Show file tree
Hide file tree
Showing 42 changed files with 166 additions and 287 deletions.
10 changes: 4 additions & 6 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
description: Configuring and running the HBM server on various distributions
keywords:
- hbm, server, configuration, running, process managers
title: "Configuring and running HBM"
description: "Configuring and running the HBM server on various distributions"
keywords: [ "hbm", "server", "configuration", "running", "process managers" ]
date: "2017-01-27"
menu:
main:
parent: hbm_admin
weight: 0
title: Configuring and running HBM
---

# ?

## Configuration

After successfully installing HBM, next is to initialize and start the HBM backend database. This is done with just a few commands. Please refer to the [command line reference](../reference/commandline/init.md).
Expand Down
10 changes: 4 additions & 6 deletions docs/admin/menu.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
description: Administer HBM
keywords:
- Administer
title: "Admin Guide"
description: "Administer HBM"
keywords: [ "Administer" ]
date: "2017-01-27"
menu:
main:
identifier: hbm_admin
parent: hbm_use
weight: -70
title: Admin Guide
---

# Admin Topics

* [Configuring and running HBM](index.md)
* [Using Puppet](puppet.md)
11 changes: 4 additions & 7 deletions docs/admin/puppet.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
---
description: Installing and using Puppet
keywords:
- puppet, installation, usage, hbm, documentation
title: "Using Puppet"
description: "Installing and using Puppet"
keywords: [ "puppet", "installation", "usage", "hbm", "documentation" ]
date: "2017-01-27"
menu:
main:
parent: hbm_admin
weight: 12
title: Using Puppet
---

# Using Puppet
***

## Requirements

To use this guide you'll need a working installation of Puppet from
Expand Down
6 changes: 2 additions & 4 deletions docs/getstarted/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
---
title: "Get started with HBM"
description: "Getting started with HBM"
tags: [ "getting started", "HBM" ]
keywords: [ "getting started", "HBM" ]
date: "2017-01-27"
url: "/docs/getstarted/install/"
url: "/docs/getstarted/hbm/"
menu:
main:
identifier: hbm_getstarted_install
parent: getstarted
weight: -85
---

# Getting Started

## Install

Refer to the [page](../installation/index.md) specific to your Linux distribution.
Expand Down
8 changes: 3 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
title: "About HBM"
description: HBM
keywords:
- hbm
keywords: [ "hbm" ]
date: "2017-01-27"
menu:
main:
identifier: hbm_use
weight: -85
title: HBM
---

# About HBM

**Secure, restrict Docker's capabilities**

[**HBM**](http://harbormaster.io) is a basic extendable
Expand Down
11 changes: 4 additions & 7 deletions docs/installation/binaries.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
---
description: Instructions for installing HBM as a binary. Mostly meant for hackers who want to try out HBM on a variety of environments.
keywords:
- binaries, installation, hbm, documentation, linux
title: "Installation from binaries"
description: "Instructions for installing HBM as a binary. Mostly meant for hackers who want to try out HBM on a variety of environments."
keywords: [ "binaries", "installation", "hbm", "documentation", "linux" ]
date: "2017-01-27"
menu:
main:
parent: hbm_install
weight: 110
title: Installation from binaries
---

# Installation from binaries
***

## Get the HBM binaries

You can download a specific version. To get the list of stable
Expand Down
12 changes: 5 additions & 7 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
---
description: Lists the installation methods
keywords:
- HBM install
title: "Install HBM"
description: "Lists the installation methods"
keywords: [ "HBM", "install" ]
date: "2017-01-27"
menu:
main:
identifier: hbm_install
parent: hbm_use
weight: -81
title: Install
---

# Install HBM

HBM is supported on Linux. Installation instructions are available for the following:

## On Linux
* [EL7](linux/el.md)
* [EL](linux/el.md)
* [RancherOS](linux/rancheros.md)

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 binaries](binaries.md).
Expand Down
11 changes: 4 additions & 7 deletions docs/installation/linux/el.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
---
description: Instructions for installing Docker on CentOS.
keywords:
- HBM, HBM documentation, requirements, linux, centos
title: "Installation on Enterprise Linux"
description: "Instructions for installing HBM on Enterprise Linux"
keywords: [ "HBM", "documentation", "requirements", "linux", "centos" ]
date: "2017-01-27"
menu:
main:
parent: hbm_linux
weight: -4
title: Installation on Enterprise Linux
---

# EL
***

HBM runs on EL. An installation on other binary compatible EL7
distributions such as CentOS, RHEL, Scientific Linux might succeed, but Harbormaster does not test
or support HBM on these distributions.
Expand Down
12 changes: 5 additions & 7 deletions docs/installation/linux/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
---
description: Lists the installation methods
keywords:
- hbm, install, linux
title: "Install HBM on Linux distributions"
description: "Lists the installation methods"
keywords: [ "hbm", "install", "linux" ]
date: "2017-01-27"
menu:
main:
identifier: hbm_linux
parent: hbm_install
weight: -70
title: On Linux distributions
---

# Install HBM on Linux

HBM is supported on several Linux distributions. Installation instructions are available for the following:

* [CentOS](centos.md)
* [Enterprise Linux](el.md)
* [RancherOS](rancheros.md)

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 binaries](../binaries.md).
11 changes: 4 additions & 7 deletions docs/reference/commandline/collection_add.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The collection add command description and usage
keywords:
- collection, add
title: "hbm collection add"
description: "The collection add command description and usage"
keywords: [ "collection", "add" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: collection add
---

# hbm collection add
***

```markdown
Add collection to the whitelist

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/collection_find.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The collection find command description and usage
keywords:
- collection, find
title: "hbm collection find"
description: "The collection find command description and usage"
keywords: [ "collection", "find" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: collection find
---

# hbm collection find
***

```markdown
Verify if collection exists in the whitelist

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/collection_ls.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The collection ls command description and usage
keywords:
- collection, ls
title: "hbm collection ls"
description: "The collection ls command description and usage"
keywords: [ "collection", "ls" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: collection ls
---

# hbm collection ls
***

```markdown
List whitelisted collections

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/collection_rm.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The collection rm command description and usage
keywords:
- collection, rm
title: "hbm collection rm"
description: "The collection rm command description and usage"
keywords: [ "collection", "rm" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: collection rm
---

# hbm collection rm
***

```markdown
Remove collection from the whitelist

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/config_find.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The config find command description and usage
keywords:
- config, find
title: "hbm config find"
description: "The config find command description and usage"
keywords: [ "config", "find" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: config find
---

# hbm config find
***

```markdown
Verify if feature is enabled

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/config_get.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The config get command description and usage
keywords:
- config, get
title: "hbm config get"
description: "The config get command description and usage"
keywords: [ "config", "get" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: config get
---

# hbm config get
***

```markdown
Get config option value

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/config_ls.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The config ls command description and usage
keywords:
- config, ls
title: "hbm config ls"
description: "The config ls command description and usage"
keywords: [ "config", "ls" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: config ls
---

# hbm config ls
***

```markdown
List HBM configs

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/config_set.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The config set command description and usage
keywords:
- config, set
title: "hbm config set"
description: "The config set command description and usage"
keywords: [ "config", "set" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: config set
---

# hbm config set
***

```markdown
Set HBM config option

Expand Down
11 changes: 4 additions & 7 deletions docs/reference/commandline/group_add.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
description: The group add command description and usage
keywords:
- group, add
title: "hbm group add"
description: "The group add command description and usage"
keywords: [ "group", "add" ]
date: "2017-01-27"
menu:
main:
parent: smn_cli
title: group add
---

# hbm group add
***

```markdown
Add group to the whitelist

Expand Down
Loading

0 comments on commit e366872

Please sign in to comment.