add link (#43)

* add link * fix path
opsmill · Feb 10, 2025 · 3a4cb02 · 3a4cb02
1 parent 3290c85
commit 3a4cb02
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 45 deletions.
diff --git a/docs/docs/nornir/readme.mdx → docs/docs/readme.mdx b/docs/docs/nornir/readme.mdx → docs/docs/readme.mdx
@@ -1,9 +1,13 @@
 ---
-title: Nornir plugin for Infrahub
+title: Nornir plugin
 ---
 
 A [Nornir](https://github.com/nornir-automation/nornir) plugin for Infrahub. Infrahub can be used as an inventory source for Nornir.
 
+## Usage
+
+For an example of how to use this plugin, see the [Simplifying Network Automation Workflows with Infrahub, Nornir, and Jinja2](https://www.opsmill.com/simplifying-network-automation-workflows-with-infrahub-nornir-and-jinja2/) blog post.
+
 ## Installation
 
 ```console

diff --git a/...nir/references/plugins/artifact_tasks.mdx → ...ocs/references/plugins/artifact_tasks.mdx b/...nir/references/plugins/artifact_tasks.mdx → ...ocs/references/plugins/artifact_tasks.mdx
diff --git a/...references/plugins/infrahub_inventory.mdx → ...references/plugins/infrahub_inventory.mdx b/...references/plugins/infrahub_inventory.mdx → ...references/plugins/infrahub_inventory.mdx
diff --git a/docs/sidebars.ts b/docs/sidebars.ts
@@ -2,13 +2,13 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
 const sidebars: SidebarsConfig = {
   nornirSidebar: [
-    'nornir/readme',
+    'readme',
     {
       type: 'category',
-      label: 'Reference',
+      label: 'Nornir Plugin Reference',
       items: [
-        'nornir/references/plugins/infrahub_inventory',
-        'nornir/references/plugins/artifact_tasks',
+        'references/plugins/infrahub_inventory',
+        'references/plugins/artifact_tasks',
       ],
     }
   ]

diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -34,7 +34,7 @@ pydantic = ">=1.7.4,!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "*"
-ruff = "0.3.3"
+ruff = "0.9.5"
 mypy = "*"
 pytest-asyncio = "^0.21.1"
 types-python-slugify = "*"

diff --git a/tasks.py b/tasks.py
@@ -8,7 +8,7 @@
 
 CURRENT_DIRECTORY = Path(__file__).resolve()
 DOCUMENTATION_DIRECTORY = CURRENT_DIRECTORY.parent / "docs"
-NORNIR_DOCUMENTATION_DIRECTORY = DOCUMENTATION_DIRECTORY / "docs" / "nornir"
+NORNIR_DOCUMENTATION_DIRECTORY = DOCUMENTATION_DIRECTORY / "docs"
 
 PLUGIN_TYPES: dict[str, str] = {"inventory": "inventory", "tasks": "tasks"}
 PLUGINS_DIRECTORY = Path("nornir_infrahub/plugins")