Skip to content

Commit

Permalink
rename extending to creating models and correct typos
Browse files Browse the repository at this point in the history
  • Loading branch information
wk committed Mar 14, 2018
1 parent 94b6638 commit f1048f9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* [Advanced Configuration](docs/Configuration.md#advanced-configuration)
* [Advanced Group Configuration](docs/Configuration.md#advanced-group-configuration)
* [Hooks](docs/Hooks.md)
5. [Extending Models](docs/Extending-Models.md)
5. [Creating and Extending Models](docs/Creating-Models.md)
6. [Help](#help)
7. [Ruby API](docs/Ruby-API.md#ruby-api)
* [Input](docs/Ruby-API.md#input)
Expand Down
8 changes: 4 additions & 4 deletions docs/Extending-Models.md → docs/Creating-Models.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Extending and Customizing Oxidized Models
# Creating and Extending Oxidized Models

Oxidized supports a growing list of [operating system types](Supported-OS-Types.md). Out of the box, most model implementations collect configuration data. Some implementations also include a conservative set of additional commands that collect basic device information (device make and model, software version, licensing information, ...) which are appended to the configuration as comments.

Expand All @@ -11,7 +11,7 @@ The example below can be used to extend the `JunOS` model to collect the output
Create the file `~/.config/oxidized/model/junos.rb` with the following contents:

```ruby
require 'oxidized/mode/junos.rb'
require 'oxidized/model/junos.rb'


class JunOS
Expand All @@ -35,7 +35,7 @@ Intuitively, it is also possible to:

## Advanced features

The loosely-coupled architecture of Oxidized allows for easy extensibility in more advanced use cases as well.
The loosely-coupled architecture of Oxidized allows for easy extensibility in more advanced use cases as well.

The example below extends the functionality of the `JunOS` model further to collect `display set` formatted configuration from the device, and utilizes the multi-output functionality of the `git` output to place the returned configuration in a separate file within a git repository.

Expand All @@ -50,7 +50,7 @@ output:
Then, `~/.config/oxidized/model/junos.rb` is adapted as following:

```ruby
require 'oxidized/mode/junos.rb'
require 'oxidized/model/junos.rb'
class JunOS
Expand Down

0 comments on commit f1048f9

Please sign in to comment.