Replace labels with roles and add roles-labels extension (#851)

recrwplay · web-flow · commit 4c1aa2d7b19f · 2025-11-04T10:38:27.000Z
diff --git a/modules/ROOT/pages/auradb/managing-databases/advanced-metrics.adoc b/modules/ROOT/pages/auradb/managing-databases/advanced-metrics.adoc
@@ -2,10 +2,8 @@
 = Advanced metrics
 :description: This section describes advanced metrics.
 :page-aliases: all-metrics.adoc
+:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated
 
-label:AuraDB-Professional[]
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
 
 Advanced metrics is a feature that enables access to a broad range of different instance and database metrics.
 
@@ -39,11 +37,9 @@ When viewing metrics, you can select from the following time intervals:
 Memory and storage charts can be toggled between absolute and relative values using the *%* toggle.
 ====
 
-=== Toggle data series
 
-label:AuraDB-Professional[]
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
+[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated]
+=== Toggle data series
 
 To hide or show individual data series, select the corresponding data series in the legend below the chart.
 
@@ -68,10 +64,9 @@ For some metrics it also provides hints about possible actions to take if that m
 
 * *Reset zoom* - If the zoom level has been altered by selecting and dragging across a chart, *Reset zoom* resets the zoom back to the selected interval.
 
-== Aggregations
 
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
+[role=label--aura-db-business-critical label--aura-db-dedicated]
+== Aggregations
 
 Most metrics will have several values for a given timestamp because of the following reasons:
 
@@ -88,11 +83,9 @@ The possible aggregations are:
 * *Average* - The average value of the metric across all cluster members.
 * *Sum* - The sum of the metric across all cluster members.
 
-== Detail view
 
-label:AuraDB-Professional[]
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
+[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated]
+== Detail view
 
 An Aura instance can run on multiple servers to achieve availability and workload scalability. 
 These servers are deployed across different Cloud Provider availability zones in the user-selected region. 
diff --git a/modules/ROOT/pages/auradb/managing-databases/backup-restore-export.adoc b/modules/ROOT/pages/auradb/managing-databases/backup-restore-export.adoc
@@ -22,11 +22,9 @@ Snapshots are available for 7 days for AuraDB Professional instances, 30 days f
 
 == Snapshot types
 
-=== Scheduled
 
-label:AuraDB-Professional[]
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
+[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated]
+=== Scheduled
 
 A *Scheduled* snapshot is a snapshot that is automatically triggered when you first create an instance, when changes to the underlying system occur (for example, a new patch release), and at a cadence depending on your plan type.
 
diff --git a/modules/ROOT/pages/auradb/managing-databases/custom-endpoints.adoc b/modules/ROOT/pages/auradb/managing-databases/custom-endpoints.adoc
@@ -1,10 +1,8 @@
 [[aura-custom-endpoints]]
 = Custom endpoints
 :description: This section describes custom endpoints.
+:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated
 
-label:AuraDB-Professional[]
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
 
 Custom endpoints can be used for database management and migration.
 
diff --git a/modules/ROOT/pages/auradb/managing-databases/database-actions.adoc b/modules/ROOT/pages/auradb/managing-databases/database-actions.adoc
@@ -16,10 +16,9 @@ To rename an instance:
 . Enter a new name for the instance.
 . Select *Rename*.
 
-== Reset an instance
 
-label:AuraDB-Free[]
-label:AuraDB-Professional[]
+[role=label--aura-db-professional label--aura-db-free]
+== Reset an instance
 
 You can clear all data in an instance using the *Reset to blank* action.
 
@@ -59,11 +58,11 @@ To upgrade a Business Critical instance:
 For more information on AuraDB instance creation settings, see xref:auradb/getting-started/create-database.adoc[].
 . Tick the *I understand* checkbox and select *Upgrade Instance*.
 
+
+[role=label--aura-db-professional label--aura-db-dedicated label--aura-db-business-critical]
 == Resize an instance
 
-label:AuraDB-Professional[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDB-Business-Critical[]
+
 
 You can change the size of an existing instance using the *Resize* action.
 
@@ -78,11 +77,9 @@ An instance remains available during the resize operation.
 
 Downward resizing to any size is supported as long as the selected instance size has enough storage capacity for the data.
 
-== Pause an instance
 
-label:AuraDB-Professional[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDB-Business-Critical[]
+[role=label--aura-db-professional label--aura-db-dedicated label--aura-db-business-critical]
+== Pause an instance
 
 [NOTE]
 ====
diff --git a/modules/ROOT/pages/auradb/managing-databases/monitoring.adoc b/modules/ROOT/pages/auradb/managing-databases/monitoring.adoc
@@ -2,10 +2,8 @@
 = Monitoring
 :description: This section describes the metrics available in Aura.
 :page-aliases: managing-instances/instance-resources.adoc
+:page-role: aura-db-professional aura-db-dedicated aura-db-business-critical
 
-label:AuraDB-Professional[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDB-Business-Critical[]
 
 You can monitor the following metrics of an AuraDB instance from the *Metrics* tab:
 
@@ -14,10 +12,7 @@ You can monitor the following metrics of an AuraDB instance from the *Metrics* t
 * *Out of Memory Errors* - The number of Out of Memory (OOM) errors encountered by the instance.
 * *Garbage Collection Time (%)* - The amount of time the instance spends reclaiming heap space as a percentage.
 * *Page Cache Evictions* - The number of times the instance has replaced data in memory.
-
-label:AuraDB-Virtual-Dedicated-Cloud[]
-
-* *Heap Usage (%)* _Only available on AuraDB Virtual Dedicated Cloud_ - The amount of Java Virtual Machine (JVM) memory used by the instance as a percentage. 
+* label:AuraDB-Virtual-Dedicated-Cloud[] *Heap Usage (%)* _Only available on AuraDB Virtual Dedicated Cloud_ - The amount of Java Virtual Machine (JVM) memory used by the instance as a percentage. 
 
 [NOTE]
 ====
diff --git a/modules/ROOT/pages/auradb/managing-databases/regions.adoc b/modules/ROOT/pages/auradb/managing-databases/regions.adoc
@@ -1,12 +1,9 @@
 [[aura-regions]]
 = Regions
 :description: This page lists all regions Aura supports deployment in, sorted by subscription plan.
+:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated
 
 
-label:AuraDB-Professional[]
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
-
 Aura supports the following regions based on your subscription plan:
 
 == Amazon Web Services (AWS)
diff --git a/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc b/modules/ROOT/pages/auradb/managing-databases/secondaries.adoc
@@ -1,8 +1,7 @@
 [[auradb-secondaries]]
 = Secondaries
 :description: This section introduces secondaries for scaling out read workloads.
-
-label:AuraDB-Virtual-Dedicated-Cloud[]
+:page-role: aura-db-dedicated
 
 A secondary is a read-only copy of your Aura database.
 Secondaries help you scale the read query workload your AuraDB instance is able to serve, by spreading the load evenly across multiple copies of the data.
diff --git a/modules/ROOT/pages/aurads/managing-instances/regionsDS.adoc b/modules/ROOT/pages/aurads/managing-instances/regionsDS.adoc
@@ -1,9 +1,7 @@
 [[regions]]
 = Regions
 :description: This page lists all regions Aura supports deployment in, sorted by subscription plan.
-
-label:AuraDS-Professional[]
-label:AuraDS-Enterprise[]
+:page-role: AuraDS-Professional AuraDS-Enterprise
 
 
 Aura supports the following regions based on your subscription plan:
diff --git a/modules/ROOT/pages/platform/api/overview.adoc b/modules/ROOT/pages/platform/api/overview.adoc
@@ -1,9 +1,8 @@
 [[aura-api-overview]]
 = Overview
 :description: This page introduces the Aura API.
+:page-role: aura-db-dedicated aura-ds-enterprise
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
 
 The Aura API allows you to programmatically perform actions on your Aura instances without the need to log in to the Console.
 
diff --git a/modules/ROOT/pages/platform/cloud-providers.adoc b/modules/ROOT/pages/platform/cloud-providers.adoc
@@ -1,11 +1,9 @@
 [[aura-cloud-providers]]
 = Aura with cloud provider marketplaces
 
-== AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB Business Critical
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
-label:AuraDB-Business-Critical[]
+[role=label--aura-db-dedicated label--AuraDS-Enterprise label--aura-db-business-critical]
+== AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB Business Critical
 
 You can purchase AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB Business Critical via private offer through the following cloud provider marketplaces:
 
@@ -15,10 +13,9 @@ You can purchase AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB B
 
 mailto:marketplace-sales@neo4j.com[Contact us] to discuss private offers.
 
-== Aura Professional
 
-label:AuraDB-Professional[]
-label:AuraDS-Professional[]
+[role=label--aura-db-professional label--AuraDS-Professional]
+== Aura Professional
 
 You can purchase Neo4j Aura Professional on a pay-as-you-go basis through the following cloud provider marketplaces:
 
diff --git a/modules/ROOT/pages/platform/consumption-report.adoc b/modules/ROOT/pages/platform/consumption-report.adoc
@@ -1,8 +1,7 @@
 [[aura-consumption-report]]
 = Consumption report
 :description: Consumption reporting allows Virtual Dedicated Cloud customers to closely monitor their consumption.
-
-label:AuraDB-Virtual-Dedicated-Cloud[]
+:page-role: aura-db-dedicated
 
 Virtual Dedicated Cloud services are offered through prepaid consumption plans.
 Billing is based on usage, with credits deducted from the available balance each month.
diff --git a/modules/ROOT/pages/platform/logging/download-logs.adoc b/modules/ROOT/pages/platform/logging/download-logs.adoc
@@ -114,10 +114,9 @@ Downloaded query logs take the form of a zipped JSON file that, when extracted,
 
 |===
 
-== Security logs
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
+[role=label--aura-db-dedicated label--AuraDS-Enterprise]
+== Security logs
 
 A security log provides a log of all the security events that have occurred on an instance within a specified time range.
 
diff --git a/modules/ROOT/pages/platform/logging/log-forwarding.adoc b/modules/ROOT/pages/platform/logging/log-forwarding.adoc
@@ -1,8 +1,7 @@
 [[aura-query-logs]]
 = Security log forwarding
+:page-role: aura-db-dedicated aura-ds-enterprise
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
 
 With security log forwarding, you can stream security logs directly to a cloud project owned by your organization, in real time.
 
diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc
@@ -1,9 +1,7 @@
 [[aura-monitoring]]
 = Query log analyzer
+:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated
 
-label:AuraDB-Professional[]
-label:AuraDB-Business-Critical[]
-label:AuraDB-Virtual-Dedicated-Cloud[]
 
 Query log analyzer is a feature that provides a UI to review the queries executed on an Aura instance.
 
diff --git a/modules/ROOT/pages/platform/metrics-integration.adoc b/modules/ROOT/pages/platform/metrics-integration.adoc
@@ -1,10 +1,8 @@
 [aura-customer-metrics-integration]
 = Customer Metrics Integration (CMI)
 :table-caption!:
+:page-role: aura-db-dedicated aura-ds-enterprise aura-db-business-critical
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
-label:AuraDB-Business-Critical[]
 
 An application performance monitoring system can be configured to fetch metrics of AuraDB instances of types:
 
diff --git a/modules/ROOT/pages/platform/security/encryption.adoc b/modules/ROOT/pages/platform/security/encryption.adoc
@@ -17,10 +17,9 @@ This ensures all your data stored in any one of these cloud providers uses 256-b
 In addition to Aura’s default encryption for data at rest, Customer Managed Keys enable security-conscious enterprises to manage encryption keys through their Cloud Service Provider's Key Management Services (KMS) on Aura, granting control over data protection and access management, including the ability to revoke access from Neo4j.
 This allows adherence to strict security policies alongside Aura's default enterprise-grade security measures.
 
-== Customer Managed Keys
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
+[role=label--aura-db-dedicated label--AuraDS-Enterprise]
+== Customer Managed Keys
 
 A Customer Managed Key (CMK) gives you more control over key operations than the standard Neo4j encryption.
 These are created and managed using a supported cloud key management service (KMS).
diff --git a/modules/ROOT/pages/platform/security/secure-connections.adoc b/modules/ROOT/pages/platform/security/secure-connections.adoc
@@ -2,10 +2,9 @@
 = Secure connections
 :description: VPC boundaries enable you to operate within an isolated section of the service.
 
-== VPC isolation
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
+[role=label--aura-db-dedicated label--AuraDS-Enterprise]
+== VPC isolation
 
 AuraDB Virtual Dedicated Cloud and AuraDS Enterprise run in a dedicated AWS cloud account, Azure subscription, or GCP project to achieve complete isolation for your deployment.
 Additional Virtual Private Cloud (VPC) boundaries enable you to operate within an isolated section of the service, where your processing, networking, and storage are further protected.
@@ -52,10 +51,9 @@ A single private link connection applies to all instances in a region.
 So if you've set one up for `us-east-1` then those network connections will apply to all instances in that region.
 You can set up a second private link connection to applications that are hosted in a second region (for example `us-west-1`) but still housed inside the same Aura project.
 
-=== AWS private endpoints
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
+[role=label--aura-db-dedicated label--AuraDS-Enterprise]
+=== AWS private endpoints
 
 AuraDB Virtual Dedicated Cloud and AuraDS Enterprise support private endpoints on AWS using https://aws.amazon.com/privatelink[AWS PrivateLink].
 
@@ -114,10 +112,9 @@ To enable private endpoints using AWS PrivateLink:
 You will need an AWS account with permissions to create, modify, describe and delete endpoints.
 Please see the https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html[AWS Documentation] for more information.
 
-=== GCP private endpoints
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
+[role=label--aura-db-dedicated label--AuraDS-Enterprise]
+=== GCP private endpoints
 
 AuraDB Virtual Dedicated Cloud and AuraDS Enterprise support private endpoints on GCP using https://cloud.google.com/vpc/docs/private-service-connect[GCP Private Service Connect].
 
@@ -172,10 +169,9 @@ To enable private endpoints using GCP Private Service Connect:
 
 Please see the https://cloud.google.com/vpc/docs/configure-private-service-connect-services[GCP Documentation] for required roles and permissions.
 
-=== Azure private endpoints
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
+[role=label--aura-db-dedicated label--AuraDS-Enterprise]
+=== Azure private endpoints
 
 AuraDB Virtual Dedicated Cloud and AuraDS Enterprise support private endpoints on Azure using https://azure.microsoft.com/en-us/products/private-link/#overview[Azure Private Link].
 
@@ -259,9 +255,9 @@ image::azure_privatelink_03_browser_bloom_over_vpn.png["Accessing Browser and Bl
 
 Please see the link:https://learn.microsoft.com/en-us/azure/private-link/rbac-permissions#private-endpoint[Azure Documentation] for required roles and permissions.
 
-== Private links
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
+[role=label--aura-db-dedicated]
+== Private links
 
 This private link section is cloud-agnostic and therefore applicable to all clouds.
 A private link provides secure network connectivity between your application and AuraDB without exposing traffic to the public internet.
diff --git a/modules/ROOT/pages/platform/security/single-sign-on.adoc b/modules/ROOT/pages/platform/security/single-sign-on.adoc
@@ -1,9 +1,8 @@
 [[aura-reference-security]]
 = Single Sign-On (SSO)
 :description: SSO allows you to log in to the Aura Console using their company IdP credentials.
+:page-role: aura-db-dedicated aura-ds-enterprise
 
-label:AuraDB-Virtual-Dedicated-Cloud[]
-label:AuraDS-Enterprise[]
 
 == SSO levels
 
diff --git a/package.json b/package.json
@@ -27,6 +27,7 @@
     "@neo4j-antora/antora-add-notes": "^0.3.1",
     "@neo4j-antora/antora-modify-sitemaps": "^0.4.4",
     "@neo4j-antora/antora-table-footnotes": "^0.3.2",
+    "@neo4j-antora/roles-labels": "^0.1.2",
     "@neo4j-documentation/macros": "^1.0.2",
     "@neo4j-documentation/remote-include": "^1.0.0",
     "antora": "3.1.14",
diff --git a/preview.yml b/preview.yml
@@ -26,6 +26,7 @@ antora:
   - require: "@neo4j-antora/antora-modify-sitemaps"
     sitemap_version: 'classic'
     move_sitemaps_to_components: true
+  - "@neo4j-antora/roles-labels"
 
 asciidoc:
   extensions:
diff --git a/publish.yml b/publish.yml
@@ -26,6 +26,7 @@ antora:
   - require: "@neo4j-antora/antora-modify-sitemaps"
     sitemap_version: '~'
     move_sitemaps_to_components: true
+  - "@neo4j-antora/roles-labels"
 
 asciidoc:
   extensions:
