From 8c2ee136bb9bf8172473c7c6cb3428d739f927bf Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 20 Jan 2026 20:26:37 -0500 Subject: [PATCH 1/2] fix docs --- README.md | 2 +- docs/docs/developer-guide.mdx | 1 + docs/docs/install.mdx | 9 +++------ 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 02ed983..7a104b6 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ docker-compose up ### Documentation -For detailed setup instructions, configuration options, and usage guide, see [SERVICE_CATALOG.md](SERVICE_CATALOG.md). +For detailed setup instructions, configuration options, and usage guide, see [docs/docs/service-catalog.mdx](docs/docs/service-catalog.mdx). ## License diff --git a/docs/docs/developer-guide.mdx b/docs/docs/developer-guide.mdx index e63040e..336dd32 100644 --- a/docs/docs/developer-guide.mdx +++ b/docs/docs/developer-guide.mdx @@ -763,6 +763,7 @@ uv run mypy . # Linting uv run ruff check . +uv run yamllint . # Formatting uv run ruff format . diff --git a/docs/docs/install.mdx b/docs/docs/install.mdx index 27c7a34..5b27fa3 100644 --- a/docs/docs/install.mdx +++ b/docs/docs/install.mdx @@ -13,7 +13,7 @@ Before you begin, ensure you have the following installed on your system: ### Required software -- **Python 3.11 or 3.12** - The demo requires a recent Python version +- **Python 3.10, 3.11 or 3.12** - The demo requires a recent Python version - **[uv](https://github.com/astral-sh/uv)** - Fast Python package manager for dependency management - **Docker** - For running Infrahub containers and optionally Containerlab (or equivalent such as OrbStack) - **Git** - For cloning the repository @@ -289,13 +289,10 @@ uv run infrahubctl object load objects/bootstrap # 4. Load security data (optional) uv run infrahubctl object load objects/security/ -# 5. Populate security relationships (optional, required if you loaded security data) -uv run python scripts/populate_security_relationships.py - -# 6. Add the demo repository +# 5. Add the demo repository uv run infrahubctl repository add DEMO https://github.com/opsmill/infrahub-bundle-dc.git --read-only --ref main -# 7. Load event actions (optional, enables automatic generator execution) +# 6. Load event actions (optional, enables automatic generator execution) uv run infrahubctl object load objects/events/ ``` From fa30d77ded0480fd99ffe89c3f7c3b4b79b364b3 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 20 Jan 2026 20:27:54 -0500 Subject: [PATCH 2/2] end of file new line fix --- .github/dependabot.yml | 1 - .github/workflows/update-infrahub.yml | 2 +- queries/config/console.gql | 2 +- queries/config/edge.gql | 2 +- queries/config/firewall.gql | 2 +- queries/config/leaf.gql | 2 +- queries/config/loadbalancer.gql | 2 +- queries/config/oob.gql | 2 +- queries/config/spine.gql | 1 - queries/topology/cabling.gql | 2 +- queries/topology/clab.gql | 2 +- queries/topology/dc.gql | 2 +- queries/validation/loadbalancer_validation.gql | 2 +- 13 files changed, 11 insertions(+), 13 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5602c4b..e657f96 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -50,4 +50,3 @@ updates: all-actions: patterns: - "*" - diff --git a/.github/workflows/update-infrahub.yml b/.github/workflows/update-infrahub.yml index 5e31a48..7447c52 100644 --- a/.github/workflows/update-infrahub.yml +++ b/.github/workflows/update-infrahub.yml @@ -84,4 +84,4 @@ jobs: --title "update test-containers to version ${{ env.INFRAHUB_VERSION }} against ${{ matrix.branch-name}}" \ --body "This PR updates test-containers to version ${{ env.INFRAHUB_VERSION }}." \ --base ${{ matrix.branch-name}} \ - --head ${{ env.BRANCH_NAME }} \ No newline at end of file + --head ${{ env.BRANCH_NAME }} diff --git a/queries/config/console.gql b/queries/config/console.gql index c35be0d..b532301 100644 --- a/queries/config/console.gql +++ b/queries/config/console.gql @@ -21,4 +21,4 @@ query oob_config($device: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/config/edge.gql b/queries/config/edge.gql index 5fd67f2..4a611da 100644 --- a/queries/config/edge.gql +++ b/queries/config/edge.gql @@ -158,4 +158,4 @@ query edge_config($device: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/config/firewall.gql b/queries/config/firewall.gql index a6b7269..2c99cdc 100644 --- a/queries/config/firewall.gql +++ b/queries/config/firewall.gql @@ -31,4 +31,4 @@ query firewall_config($device: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/config/leaf.gql b/queries/config/leaf.gql index 3f17b73..8f05502 100644 --- a/queries/config/leaf.gql +++ b/queries/config/leaf.gql @@ -168,4 +168,4 @@ query leaf_config($device: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/config/loadbalancer.gql b/queries/config/loadbalancer.gql index 75743e8..1dded5a 100644 --- a/queries/config/loadbalancer.gql +++ b/queries/config/loadbalancer.gql @@ -137,4 +137,4 @@ query loadbalancer_config($device: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/config/oob.gql b/queries/config/oob.gql index 8e8b4d6..d5fec1f 100644 --- a/queries/config/oob.gql +++ b/queries/config/oob.gql @@ -31,4 +31,4 @@ query oob_config($device: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/config/spine.gql b/queries/config/spine.gql index 0f8774a..8fbe63a 100644 --- a/queries/config/spine.gql +++ b/queries/config/spine.gql @@ -163,4 +163,3 @@ query spine_config($device: String!) { } } } - diff --git a/queries/topology/cabling.gql b/queries/topology/cabling.gql index 1e1b7b2..2918610 100644 --- a/queries/topology/cabling.gql +++ b/queries/topology/cabling.gql @@ -135,4 +135,4 @@ query topology_cables($name: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/topology/clab.gql b/queries/topology/clab.gql index d5b5652..3cca807 100644 --- a/queries/topology/clab.gql +++ b/queries/topology/clab.gql @@ -125,4 +125,4 @@ query topology_info($name: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/topology/dc.gql b/queries/topology/dc.gql index a49e014..107030e 100644 --- a/queries/topology/dc.gql +++ b/queries/topology/dc.gql @@ -169,4 +169,4 @@ query topology_dc($name: String!) { } } } -} \ No newline at end of file +} diff --git a/queries/validation/loadbalancer_validation.gql b/queries/validation/loadbalancer_validation.gql index 4677487..ff73897 100644 --- a/queries/validation/loadbalancer_validation.gql +++ b/queries/validation/loadbalancer_validation.gql @@ -137,4 +137,4 @@ query loadbalancer_validation($device: String!) { } } } -} \ No newline at end of file +}