Skip to content

Update gendocs script to generate front matter #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tamalsaha merged 3 commits into from
Dec 6, 2017
Merged

Update gendocs script to generate front matter #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2882a3b
Update gendocs script to generate front matter
tamalsaha Dec 5, 2017
8444839
added-all
tamalsaha Dec 5, 2017
a3382e8
added-all
tamalsaha Dec 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ menu:
identifier: getting-started
name: Getting Started
weight: 10
left_menu: product_searchlight_4.0.0
menu_name: product_searchlight_4.0.0
---
3 changes: 2 additions & 1 deletion docs/reference/hostfacts/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Hostfacts
description: Searchlight Hostfacts Reference
menu:
product_searchlight_4.0.0:
identifier: hostfacts
identifier: hostfacts-cli
name: Hostfacts
parent: reference
weight: 10
Expand Down
17 changes: 9 additions & 8 deletions docs/reference/hostfacts/hostfacts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@
title: Hostfacts
menu:
product_searchlight_4.0.0:
identifier: hostfacts-hostfacts
identifier: hostfacts
Copy link
Copy Markdown
Contributor

@sajibcse68 sajibcse68 Dec 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overwrites docs/reference/hostfacts/_index.md id. ID should be unique.
I followed, Identifier: <folder/parent name>- to avoid ID conflicts.

name: Hostfacts
parent: hostfacts
weight: 10
parent: hostfacts-cli
weight: 0

product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
url: /products/searchlight/4.0.0/reference/hostfacts/
aliases:
- /products/searchlight/4.0.0/reference/hostfacts/hostfacts/
---
- products/searchlight/4.0.0/reference/hostfacts/hostfacts/

---
## hostfacts

Hostfacts by AppsCode - Expose node metrics

### Synopsis


Hostfacts by AppsCode - Expose node metrics

### Options
Expand All @@ -39,7 +39,8 @@ Hostfacts by AppsCode - Expose node metrics
```

### SEE ALSO
* [hostfacts run](hostfacts_run.md) - Run server
* [hostfacts version](hostfacts_version.md) - Prints binary version number.

* [hostfacts run](/docs/reference/hostfacts/hostfacts_run.md) - Run server
* [hostfacts version](/docs/reference/hostfacts/hostfacts_version.md) - Prints binary version number.


12 changes: 5 additions & 7 deletions docs/reference/hostfacts/hostfacts_run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
---
title: Hostfacts Run
title: Run
menu:
product_searchlight_4.0.0:
identifier: hostfacts-run
name: Hostfacts Run
parent: hostfacts
weight: 20
name: Run
parent: hostfacts-cli
product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
---

## hostfacts run

Run server

### Synopsis


Run server

```
Expand Down Expand Up @@ -52,6 +49,7 @@ hostfacts run [flags]
```

### SEE ALSO
* [hostfacts](hostfacts.md) - Hostfacts by AppsCode - Expose node metrics

* [hostfacts](/docs/reference/hostfacts/hostfacts.md) - Hostfacts by AppsCode - Expose node metrics


11 changes: 5 additions & 6 deletions docs/reference/hostfacts/hostfacts_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Hostfacts Version
title: Version
menu:
product_searchlight_4.0.0:
identifier: hostfacts-version
name: Hostfacts Version
parent: hostfacts
weight: 30
name: Version
parent: hostfacts-cli
product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
Expand All @@ -16,7 +15,6 @@ Prints binary version number.

### Synopsis


Prints binary version number.

```
Expand Down Expand Up @@ -44,5 +42,6 @@ hostfacts version [flags]
```

### SEE ALSO
* [hostfacts](hostfacts.md) - Hostfacts by AppsCode - Expose node metrics

* [hostfacts](/docs/reference/hostfacts/hostfacts.md) - Hostfacts by AppsCode - Expose node metrics

3 changes: 2 additions & 1 deletion docs/reference/hyperalert/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Hyperalert
description: Searchlight Hyperalert Reference
menu:
product_searchlight_4.0.0:
identifier: hyperalert
identifier: hyperalert-cli
name: Hyperalert
parent: reference
weight: 20
Expand Down
39 changes: 20 additions & 19 deletions docs/reference/hyperalert/hyperalert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@
title: Hyperalert
menu:
product_searchlight_4.0.0:
identifier: hyperalert-hyperalert
identifier: hyperalert
Copy link
Copy Markdown
Contributor

@sajibcse68 sajibcse68 Dec 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overwrites docs/reference/hyperalert/_index.md ID.

name: Hyperalert
parent: hyperalert
weight: 10
parent: hyperalert-cli
weight: 0

product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
Copy link
Copy Markdown
Contributor

@sajibcse68 sajibcse68 Dec 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url: /products/searchlight/4.0.0/reference/hyperalert/ missing

url: /products/searchlight/4.0.0/reference/hyperalert/
aliases:
- /products/searchlight/4.0.0/reference/hyperalert/hyperalert/
---
- products/searchlight/4.0.0/reference/hyperalert/hyperalert/

---
## hyperalert

AppsCode Icinga2 plugin

### Synopsis


AppsCode Icinga2 plugin

```
Expand All @@ -42,18 +42,19 @@ hyperalert [flags]
```

### SEE ALSO
* [hyperalert check_ca_cert](hyperalert_check_ca_cert.md) - Check Certificate expire date
* [hyperalert check_component_status](hyperalert_check_component_status.md) - Check Kubernetes Component Status
* [hyperalert check_env](hyperalert_check_env.md) -
* [hyperalert check_event](hyperalert_check_event.md) - Check kubernetes events for all namespaces
* [hyperalert check_influx_query](hyperalert_check_influx_query.md) - Check InfluxDB Query Data
* [hyperalert check_json_path](hyperalert_check_json_path.md) - Check Json Object
* [hyperalert check_node_exists](hyperalert_check_node_exists.md) - Count Kubernetes Nodes
* [hyperalert check_node_status](hyperalert_check_node_status.md) - Check Kubernetes Node
* [hyperalert check_pod_exec](hyperalert_check_pod_exec.md) - Check exit code of exec command on Kubernetes container
* [hyperalert check_pod_exists](hyperalert_check_pod_exists.md) - Check Kubernetes Pod(s)
* [hyperalert check_pod_status](hyperalert_check_pod_status.md) - Check Kubernetes Pod(s) status
* [hyperalert check_volume](hyperalert_check_volume.md) - Check kubernetes volume
* [hyperalert notifier](hyperalert_notifier.md) - AppsCode Icinga2 Notifier

* [hyperalert check_ca_cert](/docs/reference/hyperalert/hyperalert_check_ca_cert.md) - Check Certificate expire date
* [hyperalert check_component_status](/docs/reference/hyperalert/hyperalert_check_component_status.md) - Check Kubernetes Component Status
* [hyperalert check_env](/docs/reference/hyperalert/hyperalert_check_env.md) -
* [hyperalert check_event](/docs/reference/hyperalert/hyperalert_check_event.md) - Check kubernetes events for all namespaces
* [hyperalert check_influx_query](/docs/reference/hyperalert/hyperalert_check_influx_query.md) - Check InfluxDB Query Data
* [hyperalert check_json_path](/docs/reference/hyperalert/hyperalert_check_json_path.md) - Check Json Object
* [hyperalert check_node_exists](/docs/reference/hyperalert/hyperalert_check_node_exists.md) - Count Kubernetes Nodes
* [hyperalert check_node_status](/docs/reference/hyperalert/hyperalert_check_node_status.md) - Check Kubernetes Node
* [hyperalert check_pod_exec](/docs/reference/hyperalert/hyperalert_check_pod_exec.md) - Check exit code of exec command on Kubernetes container
* [hyperalert check_pod_exists](/docs/reference/hyperalert/hyperalert_check_pod_exists.md) - Check Kubernetes Pod(s)
* [hyperalert check_pod_status](/docs/reference/hyperalert/hyperalert_check_pod_status.md) - Check Kubernetes Pod(s) status
* [hyperalert check_volume](/docs/reference/hyperalert/hyperalert_check_volume.md) - Check kubernetes volume
* [hyperalert notifier](/docs/reference/hyperalert/hyperalert_notifier.md) - AppsCode Icinga2 Notifier


12 changes: 5 additions & 7 deletions docs/reference/hyperalert/hyperalert_check_ca_cert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
---
title: Check CA Cert
title: Check Ca Cert
menu:
product_searchlight_4.0.0:
identifier: hyperalert-check-ca-cert
name: Check CA Cert
parent: hyperalert
weight: 15
name: Check Ca Cert
parent: hyperalert-cli
product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
---

## hyperalert check_ca_cert

Check Certificate expire date

### Synopsis


Check Certificate expire date

```
Expand Down Expand Up @@ -46,6 +43,7 @@ hyperalert check_ca_cert [flags]
```

### SEE ALSO
* [hyperalert](hyperalert.md) - AppsCode Icinga2 plugin

* [hyperalert](/docs/reference/hyperalert/hyperalert.md) - AppsCode Icinga2 plugin


13 changes: 6 additions & 7 deletions docs/reference/hyperalert/hyperalert_check_component_status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Check Component
title: Check Component Status
menu:
product_searchlight_4.0.0:
identifier: hyperalert-check-component
name: Check Component
parent: hyperalert
weight: 20
identifier: hyperalert-check-component-status
name: Check Component Status
parent: hyperalert-cli
product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
Expand All @@ -16,7 +15,6 @@ Check Kubernetes Component Status

### Synopsis


Check Kubernetes Component Status

```
Expand Down Expand Up @@ -47,6 +45,7 @@ hyperalert check_component_status [flags]
```

### SEE ALSO
* [hyperalert](hyperalert.md) - AppsCode Icinga2 plugin

* [hyperalert](/docs/reference/hyperalert/hyperalert.md) - AppsCode Icinga2 plugin


7 changes: 3 additions & 4 deletions docs/reference/hyperalert/hyperalert_check_env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ menu:
product_searchlight_4.0.0:
identifier: hyperalert-check-env
name: Check Env
parent: hyperalert
weight: 25
parent: hyperalert-cli
product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
Expand All @@ -18,7 +17,6 @@ menu_name: product_searchlight_4.0.0




```
hyperalert check_env [flags]
```
Expand All @@ -43,6 +41,7 @@ hyperalert check_env [flags]
```

### SEE ALSO
* [hyperalert](hyperalert.md) - AppsCode Icinga2 plugin

* [hyperalert](/docs/reference/hyperalert/hyperalert.md) - AppsCode Icinga2 plugin


14 changes: 6 additions & 8 deletions docs/reference/hyperalert/hyperalert_check_event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
---
title: Check CA Event
title: Check Event
menu:
product_searchlight_4.0.0:
identifier: hyperalert-check-ca-event
name: Check CA Event
parent: hyperalert
weight: 30
identifier: hyperalert-check-event
name: Check Event
parent: hyperalert-cli
product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
---

## hyperalert check_event

Check kubernetes events for all namespaces

### Synopsis


Check kubernetes events for all namespaces

```
Expand Down Expand Up @@ -53,6 +50,7 @@ hyperalert check_event [flags]
```

### SEE ALSO
* [hyperalert](hyperalert.md) - AppsCode Icinga2 plugin

* [hyperalert](/docs/reference/hyperalert/hyperalert.md) - AppsCode Icinga2 plugin


8 changes: 3 additions & 5 deletions docs/reference/hyperalert/hyperalert_check_influx_query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,17 @@ menu:
product_searchlight_4.0.0:
identifier: hyperalert-check-influx-query
name: Check Influx Query
parent: hyperalert
weight: 35
parent: hyperalert-cli
product_name: searchlight
section_menu_id: reference
menu_name: product_searchlight_4.0.0
---

## hyperalert check_influx_query

Check InfluxDB Query Data

### Synopsis


Check InfluxDB Query Data

```
Expand Down Expand Up @@ -57,6 +54,7 @@ hyperalert check_influx_query [flags]
```

### SEE ALSO
* [hyperalert](hyperalert.md) - AppsCode Icinga2 plugin

* [hyperalert](/docs/reference/hyperalert/hyperalert.md) - AppsCode Icinga2 plugin


Loading