Skip to content

Commit

Permalink
Add first screenshot. fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarros committed May 18, 2020
1 parent 329b30e commit 3f64744
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The plugin is available as a Python package in pypi and can be installed with pi
pip install ntc-netbox-plugin-onboarding
```

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

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

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

<ADD SCREEN SHOT HERE>

### API

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

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).
Sign up [here](http://slack.networktocode.com/)

## Screenshot

Onboard a single device
![Single Device Form](docs/images/single_device_form.png)
Binary file added docs/images/single_device_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3f64744

Please sign in to comment.