WIP: Update docs as per OSRB request #61
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lvrfrc87
requested review from
chadell,
scetron,
pke11y,
grelleum,
jeffkala and
pszulczewski
as code owners
lvrfrc87
changed the title
chadell
suggested changes
May 18, 2022
pszulczewski
requested changes
May 18, 2022
@chadell what is still missing in your opinion? |
It's difficult to me to concrete it, but even it has improved, I still think that our introduction to the project is not clear enough. However, we should not block the code review because of this, so let's get this PRs reviewed by the team, and we can move it to the next OSRB stage, while we are working on improving the selling point of the library. |
jeffkala
requested changes
May 19, 2022
README.md
Outdated
| @@ -1,12 +1,38 @@ | |||
| # netcompare | |||
|
|
|||
| This library is meant to be a light-weight way to compare structured output from network devices `show` commands. `netcompare` is a python library targeted at intelligently deep diffing structured data objects of json type. In addition, `netcompare` can also provide some basic testing of key/values within a data structure. | |||
| This library is meant to be a light-weight way to compare structured output. `netcompare` is a python library targeted at intelligently deep diffing structured data objects of json type. | |||
There was a problem hiding this comment.
I don't like the "is meant to be" verbiage. It "is" a light-weight...
README.md
Outdated
| ## Use Case | ||
| ## Use Cases | ||
|
|
||
| `netcompare` is meant to be a building block used within testing frameworks. Originally devised specifically to test structured data returned from network device show commands, `netcompare` is designed to deeply and intelligently diff data structures while also providing tests for specific values in the data structure. `netcompare` evolved to be agnostic from the collection of that data and can compare and test and type of data structure. |
There was a problem hiding this comment.
Suggested change
| `netcompare` is meant to be a building block used within testing frameworks. Originally devised specifically to test structured data returned from network device show commands, `netcompare` is designed to deeply and intelligently diff data structures while also providing tests for specific values in the data structure. `netcompare` evolved to be agnostic from the collection of that data and can compare and test and type of data structure. | |
| `netcompare` is a building block that can extend your testing framework. Originally devised to test structured data returned from show commands from a network device, `netcompare` is designed to deeply and intelligently diff data structures while also providing tests for specific values in the data structure. `netcompare` evolved to be agnostic from the collection of that data and can compare and test any type of data structure. |
README.md
Outdated
|
|
||
| `netcompare` is meant to be a building block used within testing frameworks. Originally devised specifically to test structured data returned from network device show commands, `netcompare` is designed to deeply and intelligently diff data structures while also providing tests for specific values in the data structure. `netcompare` evolved to be agnostic from the collection of that data and can compare and test and type of data structure. | ||
|
|
||
| With that said, it is perfectly suited to diff data gathered from network devices via show commands, Ansible playbooks, in Django based applications such as Nautobot or Netbox, and is targeted at being the 'plumbing' behind a full network automation validation solution. |
There was a problem hiding this comment.
Suggested change
| With that said, it is perfectly suited to diff data gathered from network devices via show commands, Ansible playbooks, in Django based applications such as Nautobot or Netbox, and is targeted at being the 'plumbing' behind a full network automation validation solution. | |
| `netcompare` is perfectly suited to diff data gathered from network devices via show commands, Ansible playbooks, in a Django based applications such as Nautobot or Netbox, and is targeted at being the 'plumbing' behind a full network automation validation solution. |
README.md
Outdated
|
|
||
| With that said, it is perfectly suited to diff data gathered from network devices via show commands, Ansible playbooks, in Django based applications such as Nautobot or Netbox, and is targeted at being the 'plumbing' behind a full network automation validation solution. | ||
|
|
||
| `netcompare` was developed for checking the state of the network before and after a change; however, `netcompare` is also well suited for comparing intended state derived from a Source-of-Truth or other source of intended state. |
There was a problem hiding this comment.
Suggested change
| `netcompare` was developed for checking the state of the network before and after a change; however, `netcompare` is also well suited for comparing intended state derived from a Source-of-Truth or other source of intended state. | |
| `netcompare` was originally developed to check the state of a network before and after a change; however, `netcompare` is also well suited for comparing intended state derived from a Source-of-Truth or other source of intended state. |
README.md
Outdated
|
|
||
| `netcompare` was developed for checking the state of the network before and after a change; however, `netcompare` is also well suited for comparing intended state derived from a Source-of-Truth or other source of intended state. | ||
|
|
||
| The intended usage is to collect structured `show` command output before and after a change window. Prior to closing the change window, the results are compared to help determine if the change was successful as intended and if the network is in an acceptable state. The output can be stored with the change's documentation for easy reference and proof of completion. |
There was a problem hiding this comment.
Suggested change
| The intended usage is to collect structured `show` command output before and after a change window. Prior to closing the change window, the results are compared to help determine if the change was successful as intended and if the network is in an acceptable state. The output can be stored with the change's documentation for easy reference and proof of completion. | |
| A common usage for this library is to collect structured `show` command output before and after a change window. Prior to closing the change window, the results are compared to help determine the final result of a change window. The outputs can be stored within the change documentation for easy reference and proof of completion. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Will close #60