vale

Author: petercrocker

.github/workflows/ci.yml

@@ -152,4 +152,4 @@ jobs:
           curl -sL "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz" -o vale.tar.gz
           tar -xzf vale.tar.gz
       - name: "Validate documentation style"
-        run: ./vale $(find ./docs -type f \( -name "*.mdx" -o -name "*.md" \) )
+        run: ./vale $(find ./docs/docs -type f \( -name "*.mdx" -o -name "*.md" \) )

.vale/styles/Infrahub/branded-terms-case-swap.yml

@@ -6,9 +6,9 @@ ignorecase: false
 action:
   name: replace
 swap:
-  (?i:[^/]Github): GitHub
+  '(?i:(?<![/])Github)': GitHub
   (?i:gitpod): GitPod
-  '[^/](?:graphql|Graphql|graphQL|GRAPHQL)': GraphQL
+  '(?<![/])(?:graphql|Graphql|graphQL|GRAPHQL)': GraphQL
   infrahub(?:\s|$): Infrahub
   (?i:Openconfig): OpenConfig
   opsmill(?:\s|$): OpsMill

.vale/styles/Infrahub/sentence-case.yml

@@ -21,13 +21,18 @@ exceptions:
   - BGP
   - CA certificates
   - CI
+  - CI/CD
+  - CLI
   - Codespaces
   - Containerlab
   - CoreArtifactTarget
   - CoreRepository
   - CoreGroup
+  - DC
+  - DC-2
   - Docker Compose
   - E2E
+  - Example
   - Generics
   - Git
   - GitHub
@@ -63,6 +68,8 @@ exceptions:
   - OIDC
   - Open ID Connect
   - OpsMill
+  - Option A
+  - Option B
   - Pydantic
   - Python
   - RabbitMQ
@@ -75,6 +82,7 @@ exceptions:
   - Tony Stark
   - TransformPython
   - UI
+  - Using
   - Vale
   - VS Code
   - VS Code extensions

.vale/styles/spelling-exceptions.txt

@@ -5,7 +5,9 @@ APIs
 append_git_suffix
 artifact_definitions
 artifact_name
+ASNs
 async
+Auditability
 Authentik
 boolean
 check_definitions
@@ -14,16 +16,20 @@ CloudFormation
 codespace
 codespaces
 combobox
+Composable
+composable
 config
 Config
 configs
 Containerlab
 content_type
 convert_query_response
 coroutine
+create_dc
 cypher
 Dagster
 datastore
+Dcim
 default_branch
 default_filter
 deserialized
@@ -34,6 +40,7 @@ direnv
 display_labels
 docker
 dockerfile
+docstrings
 Docstrings
 docusaurus
 e2e
@@ -42,6 +49,7 @@ enum
 enums
 env
 eslint
+Evolvability
 excalidraw
 fanout
 file_path
@@ -64,6 +72,7 @@ Infrahub's
 infrahubctl
 IP
 IPAddress
+Ipam
 IPAM
 is_empty
 is_ip_within
@@ -75,6 +84,8 @@ json
 JSONSchema
 kbps
 Keycloak
+loopback
+loopbacks
 Loopbacks
 markdownlint
 max_count
@@ -103,17 +114,23 @@ rebase
 rebased
 Redoc
 repo
+repos
 REST
+Reusability
+reusability
 schema_mapping
 sdk
+snake_case
 subcommand
 sudo
 subnet
+subnets
 supernet
 supernets
 SVIs
 template_path
 toml
+tomek
 towncrier
 Towncrier
 uncheck
@@ -122,6 +139,7 @@ upsert
 upserting
 Upserting
 userinfo
+uv
 uuid
 UUID
 validator

docs/docs/concepts.mdx

@@ -407,7 +407,7 @@ This supports multi-region deployments with delegated address management.
 
 Think of infrastructure not as static configurations, but as structured data that can be queried, transformed, and versioned like any other data.
 
-Traditional: "Here are 50 config files"
+Traditional: "Here are 50 configuration files"
 Design-driven: "Here's data representing 50 devices, query what you need"
 
 ### Generators as factories

docs/docs/install.mdx

@@ -22,7 +22,7 @@ Before you begin, ensure you have the following installed on your system:
 - **Disk space**: At least 10GB free space
 - **Network**: Internet connection for downloading dependencies and Docker images
 
-## Step 1: Install uv
+## Step 1: install uv
 
 If you don't have `uv` installed, follow the installation instructions for your operating system:
 
@@ -40,7 +40,7 @@ Verify the installation:
 uv --version
 ```
 
-## Step 2: Clone the repository
+## Step 2: clone the repository
 
 Clone the demo repository to your local machine:
 
@@ -49,7 +49,7 @@ git clone https://github.com/opsmill/infrahub-demo.git
 cd infrahub-demo
 ```
 
-## Step 3: Install Python dependencies
+## Step 3: install Python dependencies
 
 Use `uv` to install all required Python packages:
 
@@ -63,7 +63,7 @@ uv sync --group dev
 
 This creates a virtual environment and installs all necessary packages including the Infrahub SDK.
 
-## Step 4: Set up environment variables
+## Step 4: set up environment variables
 
 Create environment variables for connecting to Infrahub. You can either export them directly or create a `.env` file:
 
@@ -76,7 +76,7 @@ export INFRAHUB_API_TOKEN="06438eb2-8019-4776-878c-0941b1f1d1ec"
 The API token above is a demo token for local development only. Do not use this in production environments.
 :::
 
-## Step 5: Start Infrahub
+## Step 5: start Infrahub
 
 Start the Infrahub containers using the included invoke task:
 
@@ -100,7 +100,7 @@ You should see containers for:
 - `infrahub-message-queue` - RabbitMQ message broker
 - `infrahub-git` - Git repository server
 
-## Step 6: Access the Infrahub web interface
+## Step 6: access the Infrahub web interface
 
 Once the containers are running, open your web browser and navigate to:
 
@@ -113,11 +113,11 @@ You should see the Infrahub login screen. Use the default credentials:
 - **Username**: `admin`
 - **Password**: `infrahub`
 
-## Step 7: Bootstrap the demo data
+## Step 7: bootstrap the demo data
 
 Now that Infrahub is running, load the demo schemas and data. You can use the automated bootstrap script or run the steps manually.
 
-### Option A: Automated bootstrap (recommended)
+### Option A: automated bootstrap (recommended)
 
 Run the bootstrap script to load everything in one command:
 
@@ -127,7 +127,7 @@ Run the bootstrap script to load everything in one command:
 
 This script performs all the steps in Option B automatically.
 
-### Option B: Manual bootstrap
+### Option B: manual bootstrap
 
 If you prefer to run each step individually:
 
@@ -155,7 +155,7 @@ uv run infrahubctl object load data/events/
 Loading schemas and data can take several minutes. Watch the console output to monitor progress.
 :::
 
-## Step 8: Verify the installation
+## Step 8: verify the installation
 
 To verify that everything is set up correctly:
 

docs/docs/readme.mdx

@@ -92,7 +92,7 @@ Templates transform Infrahub data into deployable artifacts including device con
 
 ## Community and support
 
-- **Source code**: [github.com/opsmill/infrahub-demo](https://github.com/opsmill/infrahub-demo)
+- **Source code**: [GitHub repository](https://github.com/opsmill/infrahub-demo)
 - **Infrahub documentation**: [docs.infrahub.app](https://docs.infrahub.app)
 - **OpsMill website**: [opsmill.com](https://opsmill.com)
 

docs/docs/user-walkthrough.mdx

@@ -63,7 +63,7 @@ In the web interface:
 All subsequent actions will be performed on the `add-dc2` branch until you switch back to another branch.
 :::
 
-## Step 3: Load the DC-2 design
+## Step 3: load the DC-2 design
 
 The DC-2 design is a pre-configured data center topology specification that defines: