Misc cleanup

Author: jeremystretch

README.md

@@ -15,7 +15,7 @@ Before attempting to create a plugin, please assess your personal ability. Plugi
 
 ### Contents
 
-* [Step 1: Initial Setup](/tutorial/step01-initial-setup.md) (Start here!)
+* [Step 1: Initial Setup](/tutorial/step01-initial-setup.md) :arrow_left: Start here!
 * [Step 2: Models](/tutorial/step02-models.md)
 * [Step 3: Tables](/tutorial/step03-tables.md)
 * [Step 4: Forms](/tutorial/step04-forms.md)
@@ -24,7 +24,11 @@ Before attempting to create a plugin, please assess your personal ability. Plugi
 * [Step 7: Navigation](/tutorial/step07-navigation.md)
 * [Step 8: Filter Sets](/tutorial/step08-filter-sets.md)
 * [Step 9: REST API](/tutorial/step09-rest-api.md)
-* [Step 10: GraphQL API](/tutorial/step10-graphql.md)
+* [Step 10: GraphQL API](/tutorial/step10-graphql-api.md)
+
+### Reference
+
+* [NetBox Plugin Development Documentation](https://netbox.readthedocs.io/en/feature/plugins/development/)
 
 ### Getting Help
 

tutorial/step01-initial-setup.md

@@ -6,15 +6,24 @@ Before we can begin work on our plugin, we must first ensure that we have a suit
 
 ### Install NetBox
 
-TODO
+Plugin development requires a local installation of NetBox. If you don't already have NetBox installed, please consult the [installation instructions](https://netbox.readthedocs.io/en/feature/installation/).
+
+:green_circle: **Tip:** If this installation will be for development use only, it is generally necessary to complete only up to step three in the installation guide, culminating with successfully running the NetBox development server (`manage.py runserver`).
+
+:warning: **Warning:** This guide requires NetBox v3.2 or later. Attempting to use an earlier NetBox release will not work.
 
 ### 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.
 
 ```bash
 $ git clone --branch step00-empty https://github.com/netbox-community/netbox-plugin-demo
-# TODO: Include git output
+Cloning into 'netbox-plugin-demo'...
+remote: Enumerating objects: 58, done.
+remote: Counting objects: 100% (58/58), done.
+remote: Compressing objects: 100% (42/42), done.
+remote: Total 58 (delta 12), reused 58 (delta 12), pack-reused 0
+Unpacking objects: 100% (58/58), done.
 ```
 
 :blue_square: **Note:** It isn't strictly required to clone the demo repository, but it will enable you to conveniently check out snapshots of the code as the lessons progress and overcome any hiccups.
@@ -143,5 +152,5 @@ You should see the development start successfully. Open NetBox in a new browser
 
 This completes our initial setup. Now, onto the fun stuff!
 
-:arrow-right: [Step 2: Models](/tutorial/step02-models.md)
+:arrow_right: [Step 2: Models](/tutorial/step02-models.md)
 

tutorial/step02-models.md

@@ -211,13 +211,13 @@ Additionally, we've added a `key` attribute: This will allow the NetBox administ
 Now, we can reference this as the set of valid choices on the `default_action` and `action` model fields by referencing it with the `choices` keyword argument.
 
 ```python
-# AccessList
+    # AccessList
     default_action = models.CharField(
         max_length=30,
         choices=ActionChoices
     )
 
-# AccessListRule
+    # AccessListRule
     action = models.CharField(
         max_length=30,
         choices=ActionChoices
@@ -373,5 +373,5 @@ And a few rules to go with it:
 
 Excellent! We can now create access lists and rules in the database. The next few steps will work on expsoing this functionality in the NetBox user interface.
 
-:arrow-right: [Step 3: Tables](/tutorial/step03-tables.md)
+:arrow_right: [Step 3: Tables](/tutorial/step03-tables.md)
 

tutorial/step03-tables.md

@@ -78,8 +78,7 @@ class AccessListRuleTable(NetBoxTable):
         linkify=True
     )
 
-    class Meta(NetBoxTable.Meta):
-        model = AccessListRule
+    class Meta(NetBoxTable.Meta): = AccessListRule
         fields = (
             'pk', 'id', 'access_list', 'index', 'source_prefix', 'source_ports', 'destination_prefix',
             'destination_ports', 'protocol', 'action', 'description', 'actions',
@@ -92,5 +91,5 @@ class AccessListRuleTable(NetBoxTable):
 
 This should be all we need to display objects. Next, we'll define some forms to enable creating and modifying objects.
 
-:arrow-right: [Step 4: Models](/tutorial/step04-forms.md)
+:arrow_right: [Step 4: Models](/tutorial/step04-forms.md)
 

tutorial/step04-forms.md

@@ -92,5 +92,5 @@ class AccessListRuleForm(NetBoxModelForm):
 
 With our models, tables, and forms all in place, next we'll create some views to bring everything together!
 
-:arrow-right: [Step 5: Views](/tutorial/step05-views.md)
+:arrow_right: [Step 5: Views](/tutorial/step05-views.md)
 

tutorial/step05-views.md

@@ -246,5 +246,5 @@ However, if you click the link to the access list object, you'll be met by a `Te
 
 :blue_square: **Note:** You might notice that the "add" view for access list rules still doesn't work, raising a `NoReverseMatch` exception. This is because we haven't yet defined the REST API backends required to support the dynamic form fields. We'll take care of this in step nine.
 
-:arrow-right: [Step 6: Templates](/tutorial/step06-templates.md)
+:arrow_right: [Step 6: Templates](/tutorial/step06-templates.md)
 

tutorial/step06-templates.md

@@ -29,17 +29,14 @@ $ edit templates/netbox_access_lists/accesslist.html
 
 Although we need to create our own template, NetBox has done much of the work for us, and provides a generic template that we can easily extend. At the top of the file, add an `extends` tag:
 
-{% raw %}
 ```
 {% extends 'generic/object.html' %}
 ```
-{% endraw %}
 
 This tells the rendering engine to first load the NetBox template at `generic/object.html` and populate only the content we provide within the associated `block` tags.
 
 Let's extend the generic template's `content` block with some information about the access list.
 
-{% raw %}
 ```
 {% block content %}
   <div class="row mb-3">
@@ -72,7 +69,6 @@ Let's extend the generic template's `content` block with some information about
   </div>
 {% endblock content %}
 ```
-{% endraw %}
 
 Here we've created Boostrap 5 row and two column elements. In the first column, we have a simple card to display the access list's name and default action, as well as the number of rules assigned to it. And below it, you'll see an `include` tag which pulls in an additional template to render any custom fields associated with the model. In the second column, we've included two more templates to render tags and comments.
 
@@ -111,15 +107,12 @@ This makes the table available to our template as the `rules_table` context vari
 
 First, we need to import the `render_table` tag from the `django-tables2` library, so that we can render the table as HTML. Add this at the top of the template, immediately below the {% raw %}`{% extends %}`{% endraw %} tag:
 
-{% raw %}
 ```
 {% load render_table from django_tables2 %}
 ```
-{% endraw %}
 
 Then, immediately above the {% raw %}`{% endblock content %}`{% endraw %} line at the end of the file, insert the following template code:
 
-{% raw %}
 ```
   <div class="row">
     <div class="col col-md-12">
@@ -132,7 +125,6 @@ Then, immediately above the {% raw %}`{% endblock content %}`{% endraw %} line a
     </div>
   </div>
 ```
-{% endraw %}
 
 After refreshing the access list view in the browser, you should now see the rules table at the bottom of the page.
 
@@ -148,7 +140,6 @@ $ edit templates/netbox_access_lists/accesslistrule.html
 
 And copy the content below:
 
-{% raw %}
 ```
 {% extends 'generic/object.html' %}
 
@@ -227,7 +218,6 @@ And copy the content below:
   </div>
 {% endblock content %}
 ```
-{% endraw %}
 
 You'll probably be able to figure out most of this for yourself by now, but here are a few details worth mentioning:
 
@@ -239,5 +229,5 @@ You'll probably be able to figure out most of this for yourself by now, but here
 
 Feel free to experiment with different layouts and content before proceeding with the next step.
 
-:arrow-right: [Step 7: Navigation](/tutorial/step07-navigation.md)
+:arrow_right: [Step 7: Navigation](/tutorial/step07-navigation.md)
 

tutorial/step07-navigation.md

@@ -110,5 +110,5 @@ Now we should see green "add" buttons appear next to our menu links.
 
 ![Navigation menu items with buttons](/images/step07-menu-items2.png)
 
-:arrow-right: [Step 8: Filer Sets](/tutorial/step08-filter-sets.md)
+:arrow_right: [Step 8: Filer Sets](/tutorial/step08-filter-sets.md)
 

tutorial/step08-filter-sets.md

@@ -122,5 +122,5 @@ If you haven't already, create a few more access lists and rules, and experiment
 
 :green_circle: **Tip:** You may notice that we did not add a form field for the model's `id` filter: This is because it is unlikely to be useful for a human utilizing the UI. However, we still want to support filtering object by their primary keys, because it _is_ very helpful for consumers of NetBox's REST API, which we'll cover next.
 
-:arrow-right: [Step 9: REST API](/tutorial/step09-rest-api.md)
+:arrow_right: [Step 9: REST API](/tutorial/step09-rest-api.md)
 

tutorial/step09-rest-api.md

@@ -237,5 +237,5 @@ With all of our REST API components now in place, we should be able to make API
 
 ![REST API - Access list rules](/images/step09-rest-api2.png)
 
-This completes the tutorial. Well done! Now you're all set to make a plugin of your own!
+:arrow_right: [Step 10: GraphQL API](/tutorial/step10-graphql-api.md)