Skip to content
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.

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

Update icon, fix issue with missing page, make support model more clear #1235

Merged
merged 1 commit into from
Dec 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 10 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@ name: 🐛 Bug Report
about: Report a reproducible bug in the current release of ntc-templates
---
<!---
NOTE: Request for new template and adding data captured in template is not considered.
Please see README for more information.
NOTE: The following are not considered and will be immediately closed:
* Request for new templates.
* Request for adding data captured in an existing template.
* Request for Template issues without both the included error and raw data.
* Feature Requests in the form of a Bug.
* ISSUES raised without following instructions.

ISSUES raised without following instructions will be immediately closed.
Please see README for more information.
-->


Expand All @@ -17,8 +21,9 @@ Also test if the latest release, and master branch are affected too.

##### ISSUE TYPE
<!--- Pick one below and delete the rest: -->
- Bug Report
- Feature Idea
- Template Issue with error and raw data
- Bug Report with the library
- Feature - This is only relevant to the library, not templates
- Documentation Report

##### TEMPLATE USING
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ about: Propose a new feature or enhancement
### Important Note

Feature request for new templates will be closed.
Feature request for adding data captured to existing templates will be closed.

### Environment
* ntc-templates version: <!-- Example: 1.0.0 -->
Expand Down
Binary file modified docs/images/icon-ntc-templates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 10 additions & 1 deletion docs/user/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

From an outsiders view, some design choices, requirements, and testing procedures can seem arbitrary. The following list of FAQ is intended to help provide context and better guide users and contributors of ntc-templates.

## How do I test my templates?

You can follow the local development procedures, but for your convenience here are included locations to test your template:

* [textfsm.nornir.tech](https://textfsm.nornir.tech/) - An online textfsm editor.
* [Itential](https://template.itential.io/) - An online textfsm editor by Itential.

## Why is there a requirement to use `Error` in every template?

Ensuring that the textfsm template can account for every line is the only method to ensure that data was not accidentally missed. Take the following example. Initially we account for status to be:
Expand All @@ -18,7 +25,7 @@ Gi0/0/3 down down

The output would miss the G0/0/1 interface, since the `STATUS` of `admin down` not known. If this was a low percentage use case, it can go undetected, and result in incorrect information being returned. Instead, by ensuring that we fail fast, an `Error` is raised and hopefully GitHub Issue is put in.

## Then why isn't `Error` used in all templates?
### Then why isn't `Error` used in all templates?

Initially the controls were not as strong, so many templates were put in until issues like the previous became an issue.

Expand Down Expand Up @@ -52,6 +59,8 @@ The most likely reasons are:

- Did not follow the Issue creation template.
- Did not provide the data required to act upon the request.
- Did not provide the error that was created.
- Was actually a feature request that is not supported.
- A prolonged time with no response.

## What is meant that this is a parsing project, not a data modeling project?
Expand Down
3 changes: 3 additions & 0 deletions docs/user/lib_use_case.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Use Cases

The primary use case is working with network infrastructure that is using CLI based data and converting that into structured data. However, this TextFSM framework is relevant to any text that you would want to convert to structured data. Things such as Linux, emails, or some structured report that you do not control.