Skip to content

Commit 98ee8e0

Browse files
authored
Add 0.3.0 docs (#206)
1 parent 963cc53 commit 98ee8e0

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ You can find further documentation [here](https://github.com/netboxlabs/netbox-c
66

77
## Requirements
88

9-
* NetBox v4.4-beta or later
9+
* NetBox v4.4 or later
1010

1111
## Installation
1212

docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ The response will include the created object with its assigned ID and additional
168168

169169
### API output in the browser
170170

171-
As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scope/`
171+
As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scopes/`
172172

173173
```
174174
HTTP 200 OK

docs/index.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,18 @@ Let's walk through the above DHCP Scope example, to highlight the steps involved
4848
### Create the Custom Object Type
4949

5050
1. Navigate to the Custom Objects plugin in the left navigation pane and click the `+` next to `Custom Object Types`
51-
2. Choose a name for your Custom Object Type. In this case we will choose `dhcp_scope`
51+
2. Choose the relevant naming for your Custom Object Type.
5252

53-
> [!TIP]
54-
> Give your Custom Object Types URL friendly names
53+
| Field | Value |
54+
|-------------------------|---------------|
55+
| Internal name | `dhcp_scope` |
56+
| Display name (singular) | `DHCP Scope` |
57+
| Display name (plural) | `DHCP Scopes` |
58+
| URL path/slug | `dhcp_scopes` |
5559

5660
> [!TIP]
57-
> By default the plural name for your Custom Object Type will be its name with `s` appended. So for example, multiple `dhcp_scope` Custom Objects will be referred to as `dhcp_scopes`.
58-
> This behaviour can be overridden using the `Readable plural name` field. For example if you have a Custom Object Type called `Child` you can use the `Readable plural name` field to specify `Children` instead of `Childs`
61+
> You can optionally choose a version for for your custom object type, e.g. `0.1`
62+
> Custom Object Type versioning will become more important in future releases of NetBox Custom Objects
5963
6064
3. Click `Create`
6165

@@ -87,15 +91,15 @@ Typically, NetBox admins would be responsible for thinking through modelling req
8791

8892
Now that you've created your `DHCP Scope` Custom Object Type, let's go ahead and create a new `DHCP Scope`.
8993

90-
1. Under the NetBox Custom Objects plugin in the left side navigation you will now see `Dhcp_scopes`. Click on `+` next to your new Custom Object Type.
94+
1. Under the NetBox Custom Objects plugin in the left side navigation you will now see `DHCP Scopes`. Click on `+` next to your new Custom Object Type.
9195
2. As you added a single field, called `Range` of type `IPAM > IP Range` you are prompted to specify a range. Go and ahead and select one, then click `Create`.
9296
3. You're now taken to the detail view for your new `DHCP Scope` object.
9397

9498
#### Standard list views for Custom Objects
9599

96-
As with core NetBox objects, Custom Objects have their own list views. To see all your `DHCP Scopes` you can just click on your Custom Object Type in the Custom Object plugin section in the left side navigation. In the example above, click on `Custom Objects` -> `OBJECTS` -> `Dhcp_scopes`
100+
As with core NetBox objects, Custom Objects have their own list views. To see all your `DHCP Scopes` you can just click on your Custom Object Type in the Custom Object plugin section in the left side navigation. In the example above, click on `Custom Objects` -> `OBJECTS` -> `DHCP Scopes`
97101

98-
You will now see a standard NetBox list view for your new Custom Objects with the standard options including `Configure Table`, `+ Add`, Import, Export, etc
102+
You will now see a standard NetBox list view for your new Custom Objects with the standard options including `Configure Table`, `+ Add`, `Import`, `Export`, etc
99103

100104
### Deletions
101105

0 commit comments

Comments
 (0)