extern/devicetype-library
1
0
Fork 0
mirror of https://github.com/netbox-community/devicetype-library.git synced 2025-02-16 10:30:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos (#1458)

Browse Source 
Fix typos and manufacturer's position in device type's slug description.
Add link to elevation-images folder.
This commit is contained in:
Bastian Triller 2023-07-16 03:17:30 +02:00 committed by GitHub
parent 4ac4c79ab1
commit b48bd3a8bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -23,7 +23,7 @@ Each definition **must** include at minimum the following fields:
- `model`: The model number of the device type. This must be unique per manufacturer.
- Type: String
- `slug`: A URL-friendly representation of the model number. Like the model number, this must be unique per
manufacturer. All slugs should have the manufacturers name appended to it with a dash, please see the example below.
manufacturer. All slugs should have the manufacturers name prepended to it with a dash, please see the example below.
- Type: String
- Pattern: `"^[-a-zA-Z0-9_]+$"`. Must match the following characters: `-`, `_`, Uppercase or Lowercase `a` to `z`, Numbers `0` to `9`.
@ -55,11 +55,11 @@ The following fields may **optionally** be declared:
- `side-to-rear`
- `passive`
> :test_tube: **Example**: `airflow: side-to-rear`
- `front_image`: Indicates that this device has a front elevation image within the elevation-imgaes folder. (**Default: None**)
- `front_image`: Indicates that this device has a front elevation image within the [elevation-images](elevation-images/) folder. (**Default: None**)
- NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.front.<acceptable_format>
- Type: Boolean
> :test_tube: **Example**: `front_image: True`
- `rear_image`: Indicates that this device has a rear elevation image within the elevation-imgaes folder. (**Default: None**)
- `rear_image`: Indicates that this device has a rear elevation image within the [elevation-images](elevation-images/) folder. (**Default: None**)
- NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.rear.<acceptable_format>
- Type: Boolean
> :test_tube: **Example**: `rear_image: True`