Use hyphens for all configurations.

Author: cotti

config/products.yml

@@ -7,34 +7,34 @@ products:
     versioning: 'all'
   apm-agent-dotnet:
     display: 'APM .NET Agent'
-    versioning: 'apm_agent_dotnet'
+    versioning: 'apm-agent-dotnet'
   apm-agent-go:
     display: 'APM Go Agent'
-    versioning: 'apm_agent_go'
+    versioning: 'apm-agent-go'
   apm-agent-java:
     display: 'APM Java Agent'
-    versioning: 'apm_agent_java'
+    versioning: 'apm-agent-java'
   apm-agent-node:
     display: 'APM Node.js Agent'
-    versioning: 'apm_agent_node'
+    versioning: 'apm-agent-node'
   apm-agent-php:
     display: 'APM PHP Agent'
-    versioning: 'apm_agent_php'
+    versioning: 'apm-agent-php'
   apm-agent-python:
     display: 'APM Python Agent'
-    versioning: 'apm_agent_python'
+    versioning: 'apm-agent-python'
   apm-agent-ruby:
     display: 'APM Ruby Agent'
-    versioning: 'apm_agent_ruby'
+    versioning: 'apm-agent-ruby'
   apm-agent-rum-js:
     display: 'APM RUM JavaScript Agent'
-    versioning: 'apm_agent_rum'
+    versioning: 'apm-agent-rum'
   apm-k8s-attacher:
     display: 'APM Attacher for Kubernetes'
-    versioning: 'apm_attacher'
+    versioning: 'apm-attacher'
   apm-aws-lambda:
     display: 'APM AWS Lambda extension'
-    versioning: 'apm_lambda'
+    versioning: 'apm-lambda'
   apm-server:
     display: 'APM Server'
     versioning: 'stack'
@@ -61,7 +61,7 @@ products:
     versioning: 'serverless'
   cloud-terraform:
     display: 'Elastic Cloud Terraform Provider'
-    versioning: 'cloud_terraform'
+    versioning: 'cloud-terraform'
   curator:
     display: 'Elasticsearch Curator'
     versioning: 'curator'
@@ -73,31 +73,31 @@ products:
     versioning: 'stack'
   ecs-dotnet:
     display: 'ECS Logging .NET'
-    versioning: 'ecs_logging_dotnet'
+    versioning: 'ecs-logging-dotnet'
   ecs-logging-go-logrus:
     display: 'ECS Logging Go (Logrus)'
-    versioning: 'ecs_logging_go_logrus'
+    versioning: 'ecs-logging-go-logrus'
   ecs-logging-go-zap:
     display: 'ECS Logging Go (Zap)'
-    versioning: 'ecs_logging_go_zap'
+    versioning: 'ecs-logging-go-zap'
   ecs-logging-go-zerolog:
     display: 'ECS Logging Go (Zerolog)'
-    versioning: 'ecs_logging_go_zerolog'
+    versioning: 'ecs-logging-go-zerolog'
   ecs-logging-java:
     display: 'ECS Logging Java'
-    versioning: 'ecs_logging_java'
+    versioning: 'ecs-logging-java'
   ecs-logging-nodejs:
     display: 'ECS Logging Node.js'
-    versioning: 'ecs_logging_nodejs'
+    versioning: 'ecs-logging-nodejs'
   ecs-logging-php:
     display: 'ECS Logging PHP'
-    versioning: 'ecs_logging_php'
+    versioning: 'ecs-logging-php'
   ecs-logging-python:
     display: 'ECS Logging Python'
-    versioning: 'ecs_logging_python'
+    versioning: 'ecs-logging-python'
   ecs-logging-ruby:
     display: 'ECS Logging Ruby'
-    versioning: 'ecs_logging_ruby'
+    versioning: 'ecs-logging-ruby'
   edot-cf:
     display: 'EDOT Cloud Forwarder'
     versioning: 'stack'
@@ -109,31 +109,31 @@ products:
     versioning: 'stack'
   edot-ios:
     display: 'Elastic Distribution of OpenTelemetry iOS'
-    versioning: 'edot_ios'
+    versioning: 'edot-ios'
   edot-android:
     display: 'Elastic Distribution of OpenTelemetry Android'
-    versioning: 'edot_android'
+    versioning: 'edot-android'
   edot-dotnet:
     display: 'Elastic Distribution of OpenTelemetry .NET'
-    versioning: 'edot_dotnet'
+    versioning: 'edot-dotnet'
   edot-java:
     display: 'Elastic Distribution of OpenTelemetry Java'
-    versioning: 'edot_java'
+    versioning: 'edot-java'
   edot-node:
     display: 'Elastic Distribution of OpenTelemetry Node'
-    versioning: 'edot_node'
+    versioning: 'edot-node'
   edot-php:
     display: 'Elastic Distribution of OpenTelemetry PHP'
-    versioning: 'edot_php'
+    versioning: 'edot-php'
   edot-python:
     display: 'Elastic Distribution of OpenTelemetry Python'
-    versioning: 'edot_python'
+    versioning: 'edot-python'
   edot-cf-aws:
     display: 'EDOT Cloud Forwarder for AWS'
-    versioning: 'edot_cf_aws'
+    versioning: 'edot-cf-aws'
   edot-cf-azure:
     display: 'EDOT Cloud Forwarder for Azure'
-    versioning: 'edot_cf_azure'
+    versioning: 'edot-cf-azure'
   eland:
     display: 'Eland'
     versioning: 'stack'

config/versions.yml

@@ -36,105 +36,105 @@ versioning_systems:
   security: *all
 
   # APM agents
-  apm_agent_dotnet:
+  apm-agent-dotnet:
     base: 1.0
     current: 1.34.1
-  apm_agent_go:
+  apm-agent-go:
     base: 2.0
     current: 2.7.1
-  apm_agent_java:
+  apm-agent-java:
     base: 1.0
     current: 1.55.1
-  apm_agent_node:
+  apm-agent-node:
     base: 4.0
     current: 4.13.0
-  apm_agent_php:
+  apm-agent-php:
     base: 1.0
     current: 1.15.1
-  apm_agent_python:
+  apm-agent-python:
     base: 6.0
     current: 6.24.0
-  apm_agent_ruby:
+  apm-agent-ruby:
     base: 4.0
     current: 4.8.0
-  apm_agent_rum:
+  apm-agent-rum:
     base: 5.0
     current: 5.17.0
-  apm_attacher:
+  apm-attacher:
     base: 1.0
     current: 1.1.3
-  apm_lambda:
+  apm-lambda:
     base: 1.0
     current: 1.6.0
 
   # EDOTs
-  edot_collector:
+  edot-collector:
     base: 9.0
     current: 9.1.4
-  edot_ios:
+  edot-ios:
     base: 1.0
     current: 1.3.0
-  edot_android:
+  edot-android:
     base: 1.0
     current: 1.2.0
-  edot_dotnet:
+  edot-dotnet:
     base: 1.0
     current: 1.1.0
-  edot_java:
+  edot-java:
     base: 1.0
     current: 1.5.0
-  edot_node:
+  edot-node:
     base: 1.0
     current: 1.4.0
-  edot_php:
+  edot-php:
     base: 1.0
     current: 1.1.1
-  edot_python:
+  edot-python:
     base: 1.0
     current: 1.8.0
-  edot_cf_aws:
+  edot-cf-aws:
     base: 0.1
     current: 0.2.0
-  edot_cf_azure:
+  edot-cf-azure:
     base: 0.1
     current: 0.6.0
 
   # Logging
-  ecs_logging_dotnet:
+  ecs-logging-dotnet:
     base: 8.0
     current: 8.18.1
-  ecs_logging_go_logrus:
+  ecs-logging-go-logrus:
     base: 1.0
     current: 1.0.0
-  ecs_logging_go_zap:
+  ecs-logging-go-zap:
     base: 1.0
     current: 1.0.3
-  ecs_logging_go_zerolog:
+  ecs-logging-go-zerolog:
     base: 0.2
     current: 0.2.0
-  ecs_logging_java:
+  ecs-logging-java:
     base: 1.0
     current: 1.7.0
-  ecs_logging_nodejs:
+  ecs-logging-nodejs:
     base: 1.0
     current: 1.5.3
-  ecs_logging_php:
+  ecs-logging-php:
     base: 2.0
     current: 2.0.0
-  ecs_logging_python:
+  ecs-logging-python:
     base: 2.0
     current: 2.2.0
-  ecs_logging_ruby:
+  ecs-logging-ruby:
     base: 1.0
     current: 1.0.0
   esf:
     base: 1.0
     current: 1.21.0
-  search_ui:
+  search-ui:
     base: 1.0
     current: 1.24.2
 
 # Other
-  cloud_terraform:
+  cloud-terraform:
     base: 0.11
     current: 0.11.17

docs/configure/site/products.md

@@ -4,10 +4,10 @@ The [`products.yml`](https://github.com/elastic/docs-builder/blob/main/config/pr
 
 ```yml
 products:
-  apm_agent_dotnet:
+  apm-agent-dotnet:
     display: 'APM .NET Agent'
-    versioning: 'apm_agent_dotnet'
-  edot_collector:
+    versioning: 'apm-agent-dotnet'
+  edot-collector:
     display: 'Elastic Distribution of OpenTelemetry Collector'
     versioning: 'stack'
 #...
@@ -28,17 +28,21 @@ Writing `{{ product.<product-id> }}` renders the friendly name of the product in
 
 | Substitution                    | Result |
 |---------------------------------|---|
-| `{{ product.apm_agent_dotnet }}` |{{ product.apm_agent_dotnet }}  |
-| `{{ product.edot_collector }}`           | {{ product.edot_collector }} |
+| `{{ product.apm-agent-dotnet }}` |{{ product.apm-agent-dotnet }}  |
+| `{{ product.edot-collector }}`           | {{ product.edot-collector }} |
 
 You can also use the shorthand notation `{{ .<product_id> }}`. For example:
 
 | Substitution                    | Result |
 |---------------------------------|---|
-| `{{ .apm_agent_dotnet }}` |{{ .apm_agent_dotnet }}  |
-| `{{ .edot_collector }}`           | {{ .edot_collector }} |
+| `{{ .apm-agent-dotnet }}` |{{ .apm-agent-dotnet }}  |
+| `{{ .edot-collector }}`           | {{ .edot-collector }} |
 
 
+:::{note}
+While the recommended separator is a hyphen (`-`) to promote cohesion, underscores (`_`) are also supported, and internally read as hyphens.
+:::
+
 ## See also
 
 [](./versions.md)