Update readme & issue templates

This commit is contained in:
checktheroads 2021-05-30 17:12:14 -07:00
parent 231443f221
commit 1cd7d7f977
3 changed files with 30 additions and 5 deletions

View file

@ -1,13 +1,12 @@
---
name: Feature Request
about: Suggest an idea for this project
labels: enhancement
assignees: checktheroads
about: Suggest an idea for hyperglass
labels: feature
---
<!--
If the answer to any of these questions is "no", your feature request will most likely be rejected (but will still be considered).
- Is the new feature only applicable to one Network Operating System (https://hyperglass.io/docs/platforms)?
- Is the new feature _only_ applicable to one Network Operating System (https://hyperglass.io/docs/platforms)?
- Would the new feature work only on mobile, or only on desktop?
- Would the new feature only support IPv4, or IPv6?
- Is the new feature something that can be reasonably customized by hyperglass end-users?

26
.github/ISSUE_TEMPLATE/3-new-nos.yaml vendored Normal file
View file

@ -0,0 +1,26 @@
---
name: New Network Operating System
about: Request native support for a network operating system
labels: feature
body:
- type: markdown
attributes:
value: >
In order to natively support a new network operating system for hyperglass, please make sure it is supported by either Netmiko or Scrapli ([see here](https://hyperglass.io/docs/platforms)).
- type: input
attributes:
label: Manufacturer
description: What is the network vendor that manufactures the NOS? For example, for Juniper Junos, this would be Juniper.
validations:
required: true
- type: input
attributes:
label: Platform Name
description: What is the name of this NOS? For example, for Juniper Junos, this would be Junos
validations:
required: true
- type: textarea
attributes:
label: Commands
description: >
Please provide the commands required to execute hyperglass commands ([see here](https://hyperglass.io/docs/commands#adding-a-custom-command-set)). If you do not know the commands, it is likely that this request will be either denied or may take a long time to implement.

View file

@ -56,7 +56,7 @@ hyperglass is intended to make implementing a looking glass too easy not to do,
- Query multiple devices simultaneously
- Browser-based DNS-over-HTTPS resolution of FQDN queries
*To request support for a specific platform, please [submit a Github Issue](https://github.com/checktheroads/hyperglass/issues/new) with the **enhancement** label.*
*To request support for a specific platform, please [submit a Github Issue](https://github.com/checktheroads/hyperglass/issues/new) with the **feature** label.*
### [Get Started →](https://hyperglass.io/)