Skip to content

Commit

Permalink
improve spelling in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wk committed Mar 16, 2018
1 parent c79be2f commit 720facc
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ gem install pkg/*.gem

### Running with Docker

Currently, Docker Hub automatcally builds the master branch as [oxidized/oxidized](https://hub.docker.com/r/oxidized/oxidized/), you can make use of this container or build your own.
Currently, Docker Hub automatically builds the master branch as [oxidized/oxidized](https://hub.docker.com/r/oxidized/oxidized/), you can make use of this container or build your own.

To build your own, clone git repo:

Expand Down Expand Up @@ -165,7 +165,7 @@ oxidized:
- /etc/oxidized:/root/.config/oxidized
```
Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for futher info):
Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for further info):

```shell
vim /etc/oxidized/router.db
Expand Down
2 changes: 1 addition & 1 deletion docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The above strips out snmp community strings from your saved configs.

## Disabling SSH exec channels

Oxidized uses exec channels to make information extraction simpler, but there are some situations where this doesn't work well, e.g. configuring devices. This feature can be turned off by setting the `ssh_no_exec`
Oxidized uses exec channels to make information extraction simpler, but there are some situations where this doesn't work well, e.g. configuring devices. This feature can be turned off by setting the `ssh_no_exec`
variable.

```yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/Hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Following configuration keys need to be defined for all hooks:

### Events

* `node_success`: triggered when configuration is succesfully pulled from a node and right before storing the configuration.
* `node_success`: triggered when configuration is successfully pulled from a node and right before storing the configuration.
* `node_fail`: triggered after `retries` amount of failed node pulls.
* `post_store`: triggered after node configuration is stored (this is executed only when the configuration has changed).
* `nodes_done`: triggered after finished fetching all nodes.
Expand Down Expand Up @@ -62,7 +62,7 @@ hooks:
### Hook type: githubrepo
This hook configures the repository `remote` and _push_ the code when the specified event is triggerd. If the `username` and `password` are not provided, the `Rugged::Credentials::SshKeyFromAgent` will be used.
This hook configures the repository `remote` and _push_ the code when the specified event is triggered. If the `username` and `password` are not provided, the `Rugged::Credentials::SshKeyFromAgent` will be used.

`githubrepo` hook recognizes following configuration keys:

Expand Down
2 changes: 1 addition & 1 deletion docs/Model-Notes/AireOS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Cisco WLC Configuration
=======================

Create a user with read-write privilege :
Create a user with read-write privilege:

```text
mgmtuser add oxidized **** read-write
Expand Down
2 changes: 1 addition & 1 deletion docs/Model-Notes/Comware.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Comware Configuration
=====================

If you find 3Com comware devices aren't being backed up this may be due to prompt detection not matching because a previous login message is disabled after the first prompt.
If you find 3Com Comware devices aren't being backed up this may be due to prompt detection not matching because a previous login message is disabled after the first prompt.

You can disable this on the devices themselves by running this command:

Expand Down
4 changes: 2 additions & 2 deletions docs/Model-Notes/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Model Notes
===========

This directory contains implemention notes and caveats to assist you in your oxidized deployment.
This directory contains implementation notes and caveats to assist you in your oxidized deployment.

Use the table below for more information on the Vendor/Model caveats.

Expand All @@ -12,6 +12,6 @@ AireOS|[AireOS](AireOS.md)|29 Nov 2017
Arbor Networks|[ArbOS](ArbOS.md)|27 Feb 2018
Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
Xyzel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
Zyxel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018

If you discover additional caveats or problems please make sure to consult the [GitHub issues for oxidized](https://github.com/ytti/oxidized/issues) known issues.
2 changes: 1 addition & 1 deletion docs/Model-Notes/VRP-Huawei.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The commands Oxidized executes are:
3. display device
4. display current-configuration all

Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the priviledge-level for commands 1 and 4:
Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the privilege-level for commands 1 and 4:

```text
<HUAWEI> system-view
Expand Down
4 changes: 2 additions & 2 deletions docs/Sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Source: CSV

One line per device, colon seperated. If `ip` isn't present, a DNS lookup will be done against `name`. For large installations, setting `ip` will dramatically reduce startup time.
One line per device, colon separated. If `ip` isn't present, a DNS lookup will be done against `name`. For large installations, setting `ip` will dramatically reduce startup time.

```yaml
source:
Expand Down Expand Up @@ -105,7 +105,7 @@ source:

## Custom SQL Query Support

You may also implement a custom SQL query to retreive the nodelist using SQL syntax with the `query:` configuration parameter under the `sql:` stanza.
You may also implement a custom SQL query to retrieve the nodelist using SQL syntax with the `query:` configuration parameter under the `sql:` stanza.

### Custom SQL Query Examples

Expand Down

0 comments on commit 720facc

Please sign in to comment.