docs: overhaul development docs section

nautobot · Jun 13, 2024 · c4fd5ac · c4fd5ac
1 parent 8ca4f77
commit c4fd5ac
Show file tree

Hide file tree

Showing 10 changed files with 166 additions and 147 deletions.
diff --git a/README.md b/README.md
@@ -35,6 +35,10 @@ This Nautobot application framework includes the following integrations:
 
 Read more about integrations [here](https://docs.nautobot.com/projects/ssot/en/latest/user/integrations). To enable and configure integrations follow the instructions from [the install guide](https://docs.nautobot.com/projects/ssot/en/latest/admin/install/#integrations-configuration).
 
+### Building Your Own Integration
+
+If you need an integration that is not supported, you can build your own! Check out the documentation [here](https://docs.nautobot.com/projects/ssot/en/latest/dev/jobs).
+
 ### Screenshots
 
 ---

diff --git a/changes/468.documentation b/changes/468.documentation
@@ -0,0 +1 @@
+Overhauled developer documentation structure.
diff --git a/changes/468.fixed b/changes/468.fixed
@@ -0,0 +1 @@
+Fixed SSoT jobs only allowing dry run unless you overwrote the `run` method.
diff --git a/docs/dev/issues.md b/docs/dev/issues.md
@@ -0,0 +1,21 @@
+# Reference: Common Issues and Solutions
+
+This pages describes common issues when implementing SSoT integrations and their respective solutions.
+
+## Converting Types Between Database and Pydantic
+
+Developers are able to override the default loading of basic parameters to control how that parameter is loaded from Nautobot.
+
+This only works with basic parameters belonging to the model and does not override more complex parameters (foreign keys, custom fields, custom relationships, etc.).
+
+To override a parameter, add a method with the name `load_param_{param_key}` to your adapter class inheriting from `NautobotAdapter`:
+
+```python
+from nautobot_ssot.contrib import NautobotAdapter
+
+class YourSSoTNautobotAdapter(NautobotAdapter):
+    ...    
+    def load_param_time_zone(self, parameter_name, database_object):
+        """Custom loader for `time_zone` parameter."""
+        return str(getattr(database_object, parameter_name))
+```
diff --git a/docs/dev/jobs.md b/docs/dev/jobs.md
diff --git a/docs/user/modeling.md → docs/dev/modeling.md b/docs/user/modeling.md → docs/dev/modeling.md
diff --git a/docs/user/app_getting_started.md b/docs/user/app_getting_started.md
@@ -44,3 +44,5 @@ PLUGINS_CONFIG = {
 ## What are the next steps?
 
 You can check out the [Use Cases](app_use_cases.md) section for more examples.
+
+Alternatively, if you intend to build your own integration, check out [Developing Data Source and Data Target Jobs](../dev/jobs.md).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -113,7 +113,6 @@ nav:
           - Infoblox: "user/integrations/infoblox.md"
           - IPFabric: "user/integrations/ipfabric.md"
           - ServiceNow: "user/integrations/servicenow.md"
-      - Modeling: "user/modeling.md"
       - Performance: "user/performance.md"
       - Frequently Asked Questions: "user/faq.md"
       - External Interactions: "user/external_interactions.md"
@@ -147,11 +146,13 @@ nav:
           - v1.1: "admin/release_notes/version_1.1.md"
           - v1.0: "admin/release_notes/version_1.0.md"
   - Developer Guide:
+      - "Tutorial: Developing Jobs": "dev/jobs.md"
+      - "How To: Debugging Jobs": "dev/debugging.md"
+      - "Reference: Issues": "dev/issues.md"
+      - "Reference: Modeling": "dev/modeling.md"
+      - Development Environment: "dev/dev_environment.md"
       - Extending the App: "dev/extending.md"
-      - Developing Jobs: "dev/jobs.md"
-      - Debugging Jobs: "dev/debugging.md"
       - Contributing to the App: "dev/contributing.md"
-      - Development Environment: "dev/dev_environment.md"
       - Code Reference:
           - "dev/code_reference/index.md"
           - Package: "dev/code_reference/package.md"

diff --git a/poetry.lock b/poetry.lock
diff --git a/tasks.py b/tasks.py
@@ -48,7 +48,7 @@ def is_truthy(arg):
 namespace.configure(
     {
         "nautobot_ssot": {
-            "nautobot_ver": "2.1.0",
+            "nautobot_ver": "2.2.5",
             "project_name": "nautobot-ssot",
             "python_ver": "3.11",
             "local": False,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fixed SSoT jobs only allowing dry run unless you overwrote the `run` method.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -44,3 +44,5 @@ PLUGINS_CONFIG = {
		## What are the next steps?

		You can check out the [Use Cases](app_use_cases.md) section for more examples.

		Alternatively, if you intend to build your own integration, check out [Developing Data Source and Data Target Jobs](../dev/jobs.md).