From 145b2bd359490fd2a53b9a67dd4cdb1323d79642 Mon Sep 17 00:00:00 2001 From: Wild Kat Date: Tue, 12 Jun 2018 22:06:54 +0200 Subject: fix minor typos and docs lint (#1382) --- CHANGELOG.md | 4 ++-- docs/Hooks.md | 2 +- docs/Outputs.md | 1 + docs/Sources.md | 1 - docs/Supported-OS-Types.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f4ac582..7aca9e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,14 +4,14 @@ * FEATURE: add frr support to cumulus model (@User4574 / @bobthebutcher) * FEATURE: honour MAX_STAT in mtime, to store last N mtime -* FEATURE: congiurable stats history size +* FEATURE: configurable stats history size ## 0.23.0 * FEATURE: support arbitrary user/password/prompt detection in telnet, same behaviour as ssh * FEATURE: manager refactor, support local loading of input, output, source, not just model and hook * FEATURE: store modification time in node stats -* BUGFIX: model edgecos does not trigger falsepositives due to uptime and memory utilization (@sq9mev) +* BUGFIX: model edgecos does not trigger false positives due to uptime and memory utilization (@sq9mev) * BUGFIX: Use SECRET-DATA hints for hiding secrets in JunOS (@Zmegolaz) * BUGFIX: comware (@adamboutcher) diff --git a/docs/Hooks.md b/docs/Hooks.md index 09b6117..ceb8488 100644 --- a/docs/Hooks.md +++ b/docs/Hooks.md @@ -130,11 +130,11 @@ Fields sent in the message: * `model`: Model name (e.g. `eos`) * `node`: Device hostname - The AWS SNS hook requires the following configuration keys: * `region`: AWS Region name * `topic_arn`: ASN Topic reference + ### awssns hook configuration example ```yaml diff --git a/docs/Outputs.md b/docs/Outputs.md index fab3bf8..86b20ea 100644 --- a/docs/Outputs.md +++ b/docs/Outputs.md @@ -133,6 +133,7 @@ Please note that user list is only updated once at creation. The HTTP output will POST a config to the specified HTTP URL. Basic username/password authentication is supported. Example HTTP output configuration: + ```yaml output: default: http diff --git a/docs/Sources.md b/docs/Sources.md index eb3cd0c..6a55cb5 100644 --- a/docs/Sources.md +++ b/docs/Sources.md @@ -61,7 +61,6 @@ pinentry-mode loopback **NOTE** - Many database engines have reserved keywords that may conflict with Oxidized configuration field names (such as 'name', 'group', etc). Pay attention to any names that are used and observed proper quoting methods to avoid errors or unpredictable results. - ## Source: MYSQL `sudo apt-get install libmysqlclient-dev` diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md index fc010db..067e0fd 100644 --- a/docs/Supported-OS-Types.md +++ b/docs/Supported-OS-Types.md @@ -77,7 +77,7 @@ * D-Link * [D-Link](/lib/oxidized/model/dlink.rb) * EdgeCore - * [ES3528M](/lib/oxidized/model/edgecos.rb) + * [ES3528M](/lib/oxidized/model/edgecos.rb) * Ericsson/Redback * [IPOS (former SEOS)](/lib/oxidized/model/ipos.rb) * Extreme Networks -- cgit v1.2.1