Skip to content

Suggestions to improve the plugin tutorial #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Suggestions to improve the plugin tutorial #41

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
76abe4e
Minor changes, explain name of the folder
quique Mar 8, 2025
a736a9d
Add some links to reference materials
quique Mar 12, 2025
7e32690
Add link to NetBoxTable. Add image of table
quique Mar 14, 2025
a48f434
Add links to reference material, and image of the form
quique Mar 14, 2025
607fd94
Explain URL parts. Fix typo. Add links
quique Mar 14, 2025
c0c6f04
Remove color buttons
quique Mar 15, 2025
ca1c2e8
Add link to NetBoxModelFilterSetForm class
quique Mar 15, 2025
11484a6
Nested serializer classes are no longer required
quique Mar 15, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Minor changes, explain name of the folder
  • Loading branch information
@quique
quique committed Mar 8, 2025
commit 76abe4e889a804501dd7c74c5e673422e79697ac
10 changes: 6 additions & 4 deletions tutorial/step01-initial-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Be sure to enable debugging in your NetBox configuration by setting `DEBUG = Tru

### Clone the git Repository

Next, we'll clone the demo git repository from GitHub. First, `cd` into your preferred location (your home directory is probably fine), then clone the repo with `git clone`. We're checking out the `init` branch, which will provide us with an empty workspace to start.
Next, we'll clone the demo git repository from GitHub. First, `cd` into your preferred location (your home directory is probably fine), then clone the repo with `git clone`. We're checking out the `step00-empty` branch, which will provide us with an empty workspace to start.

```bash
$ git clone --branch step00-empty https://github.com/netbox-community/netbox-plugin-demo
Expand All @@ -34,7 +34,10 @@ Unpacking objects: 100% (58/58), done.

### Create `__init__.py`

The `PluginConfig` class holds all the information needs to know about our plugin to install it. First, we'll create a subdirectory to hold our plugin's Python code, as well as an `__init__.py` file to hold the `PluginConfig` definition.
Our plugin is for managing access lists in NetBox, so we'll give it an appropriate name, such as `netbox_access_lists`.

First, we'll create a subdirectory to hold our plugin's Python code, as well as an `__init__.py` file to hold the `PluginConfig` definition.
The `PluginConfig` class holds all the information Netbox needs to know about our plugin to install it.

```bash
$ mkdir netbox_access_lists
Expand Down Expand Up @@ -145,7 +148,7 @@ Save the file and run the NetBox development server (if not already running):
$ python netbox/manage.py runserver
```

You should see the development server start successfully. Open NetBox in a new browser window, log in as a superuser, and navigate to the admin UI. Under **System > Installed Plugins** you should see our plugin listed.
You should see the development server start successfully. Open NetBox in a new browser window, log in as a superuser, and navigate to the admin UI. Under **Admin > System > Plugins** you should see our plugin listed.

![Django admin UI: Plugins list](/images/step01-django-admin-plugins.png)

Expand All @@ -158,4 +161,3 @@ This completes our initial setup. Now, onto the fun stuff!
[Step 2: Models](/tutorial/step02-models.md) :arrow_right:

</div>