extern/devicetype-library
1
0
Fork 0
mirror of https://github.com/netbox-community/devicetype-library.git synced 2024-10-05 09:52:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Extend definition authoring guidance

Browse Source
This commit is contained in:
Jeremy Stretch 2019-12-26 15:35:34 -05:00
parent 8566618be6
commit 657826d2e9
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -16,11 +16,15 @@ device-types/Acme/BFR-2000.yaml
When writing new definitions, there are some important guidelines to follow:
* Every unique model number requires a discrete definition file, even if the set of components is identical.
* Definition files must end in `.yaml`, or `.yml`
* Use proper, human-friendly names when creating manufacturer directories (e.g. `Alcatel-Lucent` versus `alcatel`).
* Include only components which are fixed to the chassis. Optional modular components should be omitted from the
definition. (Note that this does not exclude field-replaceable hardware that is expected to always be present, such
as power supplies.)
* Name components exactly as they appear in the device's operating system (as opposed to the physical chassis label, if
different).
* Use the complete form of interface names where applicable. For example, use `TenGigabitEthernet1/2/3` instead of
`Te1/2/3`.
Additionally, be sure to adhere to the following style guidance: