Sync docs from infrahub repo

github-actions · github-actions · commit 20c8fb5c5482 · 2026-07-19T19:50:56.000Z
diff --git a/docs/docs/deploy-manage/run-observe/telemetry.mdx b/docs/docs/deploy-manage/run-observe/telemetry.mdx
@@ -2,7 +2,7 @@
 title: Local Telemetry Storage
 ---
 
-# Local Telemetry Storage
+# Local telemetry storage
 
 Infrahub stores a daily telemetry snapshot locally in the Neo4j database, regardless of whether remote telemetry reporting is enabled. This ensures all deployments - including air-gapped and opted-out environments - retain usage data for support, auditing, and license compliance.
 
diff --git a/docs/docs/deploy-manage/user-management/ldap/configure-ldap.mdx b/docs/docs/deploy-manage/user-management/ldap/configure-ldap.mdx
@@ -138,7 +138,7 @@ attribute_disabled = "userAccountControl"
 </TabItem>
 </Tabs>
 
-## Step 5: Enable LDAP and restart
+## Step 5: enable LDAP and restart
 
 Set `enabled` to turn LDAP sign-in on, then restart the Infrahub server to apply the configuration.
 
diff --git a/docs/docs/deploy-manage/user-management/sso/configure-sso.mdx b/docs/docs/deploy-manage/user-management/sso/configure-sso.mdx
@@ -5,7 +5,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import ReferenceLink from "../../../../src/components/Card";
 
-# Configure SSO (Single sign-on)
+# Configure SSO (single sign-on)
 
 This guide walks you through configuring single sign-on (SSO) in Infrahub using OpenID Connect (OIDC) or OAuth2 authentication protocols.
 
@@ -187,7 +187,7 @@ At the end of this step, you should have gathered all the necessary information
 
 :::
 
-## Step 3: Configure Infrahub
+## Step 3: configure Infrahub
 
 Now configure Infrahub to connect to your identity provider using either environment variables or the `infrahub.toml` configuration file.
 
diff --git a/docs/docs/development-resources/sbom.mdx b/docs/docs/development-resources/sbom.mdx
@@ -40,7 +40,7 @@ Use the exact image reference you deploy. The attestation is attached to the ima
 
 Use `cosign verify-attestation` to confirm the signature is valid **and** return the SBOM in a single step. Because signing is keyless, you must specify the signing identity and the OIDC issuer.
 
-The `jq` selector `(.payload // .dsseEnvelope.payload)` below is format-agnostic: it reads the `payload` field from cosign's legacy output and falls back to `dsseEnvelope.payload` for the newer DSSE bundle format that cosign v3 emits.
+The `jq` selector `(.payload // .dsseEnvelope.payload)` below is format-agnostic: it reads the `payload` field from the legacy cosign output and falls back to `dsseEnvelope.payload` for the newer DSSE bundle format that cosign v3 emits.
 
 ### SPDX
 
diff --git a/docs/docs/ipam/building-your-schema.mdx b/docs/docs/ipam/building-your-schema.mdx
@@ -58,7 +58,7 @@ IP prefixes are organised as a hierarchy. Hierarchical nodes have special relati
 IP prefixes also expose the following read-only computed attributes:
 
 - `utilization` — utilization of the prefix as a percentage
-- `netmask` — network mask, e.g. `255.255.255.0`
-- `hostmask` — host mask, e.g. `0.0.0.255`
+- `netmask` — network mask, for example `255.255.255.0`
+- `hostmask` — host mask, for example `0.0.0.255`
 - `network_address` — first IP address of the prefix
 - `broadcast_address` — last IP address of the prefix
diff --git a/docs/docs/object-templates/overview.mdx b/docs/docs/object-templates/overview.mdx
@@ -37,7 +37,7 @@ This combination allows you to use templates for structural definition (which po
 
 <ReferenceLink title="Creating and assigning Profiles" url="../profiles/overview" />
 
-## Integration with Resource Pools
+## Integration with resource pools
 
 Templates can be wired to resource pools so that unique values are allocated automatically when objects are created from the template. Rather than manually assigning an IP address or number attribute to each new object, you define once on the template which pool to draw from and Infrahub handles allocation at creation time.
 
diff --git a/docs/docs/profiles/create.mdx b/docs/docs/profiles/create.mdx
@@ -14,7 +14,7 @@ Define a reusable set of attribute values for a Profile-enabled node type.
 
 ## Create the Profile
 
-Replace `<Kind>` with your node kind (e.g. `InfraInterface`), `<profile-name>` with a unique name (3-32 characters), and `<attribute>` / `<value>` with the values you want the Profile to set.
+Replace `<Kind>` with your node kind (for example `InfraInterface`), `<profile-name>` with a unique name (3-32 characters), and `<attribute>` / `<value>` with the values you want the Profile to set.
 
 <Tabs groupId="method" queryString>
 <TabItem value="web" label="Web interface">
diff --git a/docs/docs/profiles/overview.mdx b/docs/docs/profiles/overview.mdx
@@ -67,7 +67,7 @@ Each Profile contains:
 
 For details on how Profile values are resolved when an object is created or updated, see [Priority and inheritance](./priority-and-inheritance.mdx).
 
-## Profiles vs Object Templates
+## Profiles vs Object templates
 
 Profiles and [Object Templates](../object-templates/overview) are complementary features that solve different parts of the configuration management problem.
 
diff --git a/docs/docs/release-notes/infrahub/release-1_10_0.mdx b/docs/docs/release-notes/infrahub/release-1_10_0.mdx
@@ -57,7 +57,7 @@ Infrahub can now **create account groups automatically from identity-provider cl
 
 Activate it by setting a claim filter:
 
-- `security.auto_create_groups_filter` (`INFRAHUB_SECURITY_AUTO_CREATE_GROUPS_FILTER`) - a regular expression, or an ordered list of them, matched against each incoming group claim. The first match wins. A named capture group `(?P<name>...)` becomes the local group name (e.g. `^LDAP/group/(?P<name>.+)$` maps `LDAP/group/network-eng` to `network-eng`); with no capture the full claim is used. Non-matching claims are dropped, so unrelated IdP groups never appear in Infrahub. Setting this filter is what activates the feature; leaving it empty keeps auto-creation off.
+- `security.auto_create_groups_filter` (`INFRAHUB_SECURITY_AUTO_CREATE_GROUPS_FILTER`) - a regular expression, or an ordered list of them, matched against each incoming group claim. The first match wins. A named capture group `(?P<name>...)` becomes the local group name (for example `^LDAP/group/(?P<name>.+)$` maps `LDAP/group/network-eng` to `network-eng`); with no capture the full claim is used. Non-matching claims are dropped, so unrelated IdP groups never appear in Infrahub. Setting this filter is what activates the feature; leaving it empty keeps auto-creation off.
 - `security.auto_create_groups_max_per_login` - caps the number of *new* groups created in a single login (default `50`). Reuse of existing groups is never capped. If the cap is hit, surplus claims are dropped, a warning event is emitted, and the login still completes.
 
 Auto-created groups start with no roles or permissions and run on every external login (OIDC, OAuth2, and native LDAP). If at least one claim matches, it takes precedence over the existing `security.sso_user_default_group` fallback; if none match, that fallback still applies.
@@ -85,7 +85,7 @@ This is a **breaking change** for consumers that previously read `extensions.cod
 Schema `order_by` entries add two capabilities, letting designers set smarter defaults without passing an ordering argument on every query or view:
 
 - Order by **object-level metadata**: `node_metadata__created_at` and `node_metadata__updated_at` sort by the timestamps Infrahub tracks on every node.
-- Add an **explicit direction**: any entry may end in `__asc` or `__desc` (e.g. `name__value__desc`, `node_metadata__created_at__desc`). Without a suffix, ascending is assumed, so existing `order_by` definitions keep their current behavior.
+- Add an **explicit direction**: any entry may end in `__asc` or `__desc` (for example `name__value__desc`, `node_metadata__created_at__desc`). Without a suffix, ascending is assumed, so existing `order_by` definitions keep their current behavior.
 
 The new grammar is honored consistently across top-level listings, relationship-peer listings, and hierarchy (`ancestors`/`descendants`) listings, and a node UUID tiebreaker is always appended so ordering - and pagination - is stable across all paths.
 
@@ -177,7 +177,7 @@ Recent releases across the Infrahub tooling during this cycle:
 
 [Infrahub Sync release notes →](https://docs.infrahub.app/sync/release-notes/infrahub-sync)
 
-### Infrahub AI Skills
+### Infrahub AI skills
 
 Infrahub AI Skills give an AI assistant built-in Infrahub expertise, so a team can build, query, and audit Infrahub from natural language. They are now ready for everyday use.
 
@@ -218,7 +218,7 @@ Read this section before upgrading.
 
 ### Structured GraphQL error codes
 
-GraphQL error responses now return a stable **string** code in `extensions.code` (e.g. `"NODE_NOT_FOUND"`, `"AUTHENTICATION_REQUIRED"`), a typed `extensions.data` payload, and a new integer `extensions.http_status`. Previously `extensions.code` was an **integer** mirroring the HTTP status (most visible on the `/graphql` authentication short-circuit path).
+GraphQL error responses now return a stable **string** code in `extensions.code` (for example `"NODE_NOT_FOUND"`, `"AUTHENTICATION_REQUIRED"`), a typed `extensions.data` payload, and a new integer `extensions.http_status`. Previously `extensions.code` was an **integer** mirroring the HTTP status (most visible on the `/graphql` authentication short-circuit path).
 
 ```json
 // Before
@@ -279,7 +279,7 @@ query {
 }
 ```
 
-### Single Sign-On account identity
+### Single sign-on account identity
 
 SSO accounts are now keyed on the provider-issued `sub` rather than the display name (see [Reworked SSO account identity](#reworked-sso-account-identity)). The transitional `INFRAHUB_SECURITY_SSO_ACCOUNT_NAME_FALLBACK` setting (default enabled, deprecated) preserves the old display-name matching during the transition. Ensure all SSO users log in once after upgrading before you disable it, otherwise accounts that have not re-logged in will be treated as new and duplicated.
 
@@ -387,7 +387,7 @@ The repository [infrahub-demo-edge](https://github.com/opsmill/infrahub-demo-edg
 
 ### Changed
 
-- **Breaking:** GraphQL error responses now carry a stable string code in `extensions.code` (e.g. `"NODE_NOT_FOUND"`, `"AUTHENTICATION_REQUIRED"`) and a typed `extensions.data` payload, plus a new integer `extensions.http_status`. Previously `extensions.code` was an integer mirroring the HTTP status. Consumers reading the integer code (most commonly on the `/graphql` auth-short-circuit path) must migrate to switching on the string code; numeric checks now read `extensions.http_status`. REST `/api/...` responses are unchanged.
+- **Breaking:** GraphQL error responses now carry a stable string code in `extensions.code` (for example `"NODE_NOT_FOUND"`, `"AUTHENTICATION_REQUIRED"`) and a typed `extensions.data` payload, plus a new integer `extensions.http_status`. Previously `extensions.code` was an integer mirroring the HTTP status. Consumers reading the integer code (most commonly on the `/graphql` auth-short-circuit path) must migrate to switching on the string code; numeric checks now read `extensions.http_status`. REST `/api/...` responses are unchanged.
 - HFID attribute values are now indexed in Neo4j for faster lookup. A migration normalizes existing HFID values to consistent all-string format and adds database indexes. The HFID lookup query has been simplified to match directly on the stored value instead of reconstructing per-field filters.
 - Improve merge performance by moving the logic to the database level
 - Improved design of the account token list page
diff --git a/docs/docs/release-notes/infrahub/release-1_10_1.mdx b/docs/docs/release-notes/infrahub/release-1_10_1.mdx
@@ -25,7 +25,7 @@ title: Release 1.10.1
 ### Fixed
 
 - Periodic Git synchronization now imports new commits on a repository's configured default branch when that branch is not `main`. Previously the sync loaded repositories without their `default_branch` attribute, fell back to the schema default of `main`, and failed to locate the worktree, leaving such repositories pinned to a stale commit while still reporting `in-sync`. ([#9600](https://github.com/opsmill/infrahub/issues/9600))
-- Fixed branches with a slash in their name (e.g. feature/my-branch) not being clickable on the Branches page. ([#9716](https://github.com/opsmill/infrahub/issues/9716))
+- Fixed branches with a slash in their name (for example feature/my-branch) not being clickable on the Branches page. ([#9716](https://github.com/opsmill/infrahub/issues/9716))
 - Restored webhook delivery: configured webhooks now fire for every triggering event, including events not associated with a branch such as account activity, instead of silently sending no request. ([#9742](https://github.com/opsmill/infrahub/issues/9742))
 - Fixed webhook automation configuration running a database read on the shared worker database without opening its own session. This left a Neo4j session cached on the shared connection and could trigger `RuntimeError: read() called while another coroutine is already waiting for incoming data` in concurrently running flows. Webhook configuration now opens a dedicated read-only session.
 - Merging a branch that changes a computed attribute, display label, or human-friendly ID template now refreshes those derived values on nodes that exist only on the target branch. Previously the merge applied the new schema without emitting a schema-update event, so the backfill never ran and the affected nodes kept stale values.
diff --git a/docs/docs/release-notes/infrahub/release-1_8_0.mdx b/docs/docs/release-notes/infrahub/release-1_8_0.mdx
@@ -104,13 +104,13 @@ The diff data is now tied to the Proposed Change itself rather than solely to th
 
 This feature is a prerequisite for a future capability to automatically delete branches after merge, which will help prevent stale branches that can cause Git synchronization issues.
 
-### Read-only repository: Update to Latest button
+### Read-only repository: update to latest button
 
 Managing read-only Git repositories is now simpler. A new "Update to Latest" button fetches and imports the latest commit from the tracked branch directly from the UI. Previously, users had to manually copy and paste commit hashes from an external source to update what Infrahub was tracking. The existing reimport action has been renamed to "Reimport Current Commit" to clearly distinguish between re-processing the current commit and pulling the latest.
 
 Repositories now also support providing a Git Tag as the reference (ref) to track for a repository.
 
-### Infrahub Backup: Kubernetes support
+### Infrahub backup: Kubernetes support
 
 The `infrahub-backup` CLI tool now fully supports Kubernetes deployments for both backup and restore operations. The tool automatically detects whether Infrahub is running on Docker Compose or Kubernetes and adjusts its behavior accordingly.
 
@@ -140,7 +140,7 @@ The branch list page continues to evolve with richer information and better usab
 
 - **Created By** column shows who created each branch (available for branches created after 1.7)
 - **Proposed Changes** column links directly to associated proposed changes
-- **Status** column shows branch state with warning indicators (e.g., "Rebase needed")
+- **Status** column shows branch state with warning indicators (for example, "Rebase needed")
 - **Schema Changes** indicator shows whether the branch includes schema modifications
 - **Last Rebase** timestamp for sync tracking
 - **Merged badge** clearly identifies branches that have been merged
@@ -165,7 +165,7 @@ Infrahub v1.8.0 requires the usage of infrahub-sdk v1.19.0, please update the `i
 
 Notable SDK changes in this release:
 - Added support for the File Object feature
-- Fixed an issue where the SDK tracking feature would fail when deleting a parent node with component relationships (e.g., a device with interfaces). The SDK now correctly handles cascade deletions where component nodes are automatically removed when their parent is deleted, preventing "Unable to find the node" errors in Generator workflows.
+- Fixed an issue where the SDK tracking feature would fail when deleting a parent node with component relationships (for example, a device with interfaces). The SDK now correctly handles cascade deletions where component nodes are automatically removed when their parent is deleted, preventing "Unable to find the node" errors in Generator workflows.
 
 ## Migration of an Infrahub instance
 
@@ -246,7 +246,7 @@ The repository [infrahub-demo-edge](https://github.com/opsmill/infrahub-demo-edg
 - Added ability to view artifact changes from the branch details view
 - Added consistent focus outline color across all interactive elements for improved visual accessibility
 - Added counts to proposed change tabs
-- Added icons next to field names in the object details view to indicate field types (e.g., text, number, boolean) and relationship schemas
+- Added icons next to field names in the object details view to indicate field types (for example, text, number, boolean) and relationship schemas
 - Added status badges to file and artifact diffs showing the type of change (added, removed, updated)
 - Added tooltip over action buttons (download/copy) on artifact details view.
 
diff --git a/docs/docs/release-notes/infrahub/release-1_9_0.mdx b/docs/docs/release-notes/infrahub/release-1_9_0.mdx
@@ -194,7 +194,7 @@ Jinja2-based computed attributes that depend on attributes or relationships on t
 Concretely:
 
 - Updating an attribute used by a local computed attribute recomputes it inline; the mutation response contains the new value.
-- Changing a relationship used by a local computed attribute (e.g. re-assigning a `Device` to a different `Site`) recomputes inline against the new peer's attributes.
+- Changing a relationship used by a local computed attribute (for example re-assigning a `Device` to a different `Site`) recomputes inline against the new peer's attributes.
 - Bulk-updating thousands of nodes no longer spawns thousands of per-node background tasks for local changes.
 - Each local-change mutation emits **one** consolidated event/webhook containing both the original change and the updated computed attribute, instead of two separate events.
 - **Remote** changes (peer-node updates that affect computed attributes on other nodes) continue to use the existing background-task path - no behavioural change there. Python Transform-based computed attributes are also unchanged.
diff --git a/docs/docs/release-notes/infrahub/release-1_9_7.mdx b/docs/docs/release-notes/infrahub/release-1_9_7.mdx
@@ -18,7 +18,7 @@ title: Release 1.9.7
   </tbody>
 </table>
 
-### Breaking Changes
+### Breaking changes
 
 - Schema attribute and relationship names containing `__` are now rejected at load time, since `__` is reserved as the schema path separator. Any existing schema using such names will fail to load after upgrading — rename the affected attributes or relationships in your schema files (and remove or rename the corresponding data) before upgrading. ([#9209](https://github.com/opsmill/infrahub/issues/9209))
 
@@ -31,7 +31,7 @@ title: Release 1.9.7
 ### Fixed
 
 - Prefix pools no longer allocate the same prefix multiple times when the pool resource has the same prefix length as the requested allocation size. Prefix pools can now correctly allocate a prefix that uses an entire linked resource.
-- Fix schema processing crashing with `'NodeSchema' object has no attribute 'get'` when a node defines a single-element relationship-only `uniqueness_constraints` entry (e.g. `[["parent"]]`). ([#4483](https://github.com/opsmill/infrahub/issues/4483))
+- Fix schema processing crashing with `'NodeSchema' object has no attribute 'get'` when a node defines a single-element relationship-only `uniqueness_constraints` entry (for example `[["parent"]]`). ([#4483](https://github.com/opsmill/infrahub/issues/4483))
 - The 'Manage Groups' dropdown and the bulk 'Add to groups' toolbar now hide groups whose `group_type` is `internal`, so only user-assignable groups appear in the selector. ([#4872](https://github.com/opsmill/infrahub/issues/4872))
 - RelationshipAdd now allows setting a cardinality-one relationship (previously, any attempt was rejected). A second add is rejected when a peer is already present. RelationshipRemove now enforces mandatory constraints on cardinality-many relationships and rejects removals that would leave a mandatory relationship with no peers. ([#5794](https://github.com/opsmill/infrahub/issues/5794))
 - GraphQL variables used inside the `data` sub-object of `IPPrefixPoolGetResource` and `IPAddressPoolGetResource` mutations now resolve correctly instead of being silently ignored (set to null). ([#6850](https://github.com/opsmill/infrahub/issues/6850))
diff --git a/docs/docs/schema/relationships.mdx b/docs/docs/schema/relationships.mdx
@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
 
 # Relationships
 
-A `Relationship` in Infrahub represents a typed link between two nodes. Unlike a simple foreign key, relationships have a `kind` that determines how they appear in the UI and how they behave during deletion and hierarchy traversal.
+A `Relationship` in Infrahub represents a typed link between two nodes. Unlike a foreign key, relationships have a `kind` that determines how they appear in the UI and how they behave during deletion and hierarchy traversal.
 
 ## Relationship kinds
 
