Skip to content

Commit 3f64744

Browse files
committed
Add first screenshot. fix typo
1 parent 329b30e commit 3f64744

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The plugin is available as a Python package in pypi and can be installed with pi
1515
pip install ntc-netbox-plugin-onboarding
1616
```
1717

18-
Once installed, the plugin need to be enabled in your `configuration.py`
18+
Once installed, the plugin needs to be enabled in your `configuration.py`
1919
```python
2020
# In your configuration.py
2121
PLUGINS = ["netbox_onboarding"]
@@ -47,7 +47,7 @@ If `Platform`, `Device Type` and/or `Device Role` are not provided, the plugin w
4747
### Onboard a new device
4848

4949
A new device can be onboarded via :
50-
- A web form
50+
- A web form `/plugins/onboarding/add/`
5151
- A CSV form to import multiple devices in bulk. `/plugins/onboarding/import/`
5252
- An API, `POST /api/plugins​/onboarding​/onboarding​/`
5353

@@ -61,8 +61,6 @@ The status of the onboarding process for each device is maintained is a dedicate
6161
- Via the UI `/plugins/onboarding/`
6262
- Via the API `GET /api/plugins​/onboarding​/onboarding​/`
6363

64-
<ADD SCREEN SHOT HERE>
65-
6664
### API
6765

6866
The plugin includes 4 API endpoints to manage the onbarding tasks
@@ -121,3 +119,8 @@ Each command can be executed with `invoke <command>`. All commands support the a
121119

122120
For any questions or comments, please check the [FAQ](FAQ.md) first and feel free to swing by the [Network to Code slack channel](https://networktocode.slack.com/) (channel #networktocode).
123121
Sign up [here](http://slack.networktocode.com/)
122+
123+
## Screenshot
124+
125+
Onboard a single device
126+
![Single Device Form](docs/images/single_device_form.png)

docs/images/single_device_form.png

81 KB
Loading

0 commit comments

Comments
 (0)