Revert to kebab-case product definition and allow compatibility with frontmatter definitions

Author: cotti

config/legacy-url-mappings.yml

@@ -8,40 +8,40 @@ stack: &stack [ '8.19', '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12',
 
 mappings:
   en/apm/agent/android/:
-    product: apm_agent_android
+    product: apm-agent-android
     legacy_versions: [ '1.2.0' , '0.x' ]
   en/apm/agent/dotnet/:
-    product: apm_agent_dotnet
+    product: apm-agent-dotnet
     legacy_versions: [ '1.33.0' ]
   en/apm/agent/go/:
-    product: apm_agent_go
+    product: apm-agent-go
     legacy_versions: [ '2.7.1', '1.x', '0.5' ]
   en/apm/agent/java/:
-    product: apm_agent_java
+    product: apm-agent-java
     legacy_versions: ['1.54.0', '0.7', '0.6']
   en/apm/agent/nodejs/:
-    product: apm_agent_node
+    product: apm-agent-node
     legacy_versions: [ '4.x', '3.x', '2.x', '1.x' ]
   en/apm/agent/php/:
-    product: apm_agent_php
+    product: apm-agent-php
     legacy_versions: [ '1.15.1', '1.x' ]
   en/apm/agent/python/:
-    product: apm_agent_python
+    product: apm-agent-python
     legacy_versions: [ '6.24.0', '5.x', '4.x', '3.x', '2.x', '1.x' ]
   en/apm/agent/ruby/:
-    product: apm_agent_ruby
+    product: apm-agent-ruby
     legacy_versions: [ '4.8.0', '3.x', '2.x', '1.x' ]
   en/apm/agent/rum-js/:
-    product: apm_agent_rum_js
+    product: apm-agent-rum-js
     legacy_versions: [ '5.17.0', '4.x', '3.x', '2.x', '1.x', '0.x' ]
   en/apm/agent/swift/:
-    product: apm_agent_ios
+    product: apm-agent-ios
     legacy_versions: [ '1.2.1', '0.x' ]
   en/apm/attacher/:
-    product: apm_k8s_attacher
+    product: apm-k8s-attacher
     legacy_versions: [ '1.1.3' ]
   en/apm/lambda/:
-    product: apm_aws_lambda
+    product: apm-aws-lambda
     legacy_versions: [ '1.5.8' ]
   en/beats/auditbeat/:
     product: auditbeat
@@ -80,61 +80,61 @@ mappings:
     product: winlogbeat
     legacy_versions: *stack
   en/cloud-heroku/:
-    product: cloud_hosted
+    product: cloud-hosted
     legacy_versions: []
   en/cloud-on-k8s/:
-    product: cloud_kubernetes
+    product: cloud-kubernetes
     legacy_versions: [ '3.0+', '2.16', '2.15', '2.14', '2.13', '2.12', '2.11', '2.10', '2.9', '2.8', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', '2.1', '2.0', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
   en/cloud/:
-    product: cloud_hosted
+    product: cloud-hosted
     legacy_versions: []
   en/cloud-enterprise/:
-    product: cloud_enterprise
+    product: cloud-enterprise
     legacy_versions: [ '4.0', '3.8', '3.7', '3.6', '3.5', '3.4', '3.3', '3.2', '3.1', '3.0', '2.13', '2.12', '2.11', '2.10', '2.9', '2.8', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', '2.1', '2.0', '1.1', '1.0' ]
   en/ecctl/:
-    product: cloud_control_ecctl
+    product: cloud-control-ecctl
     legacy_versions: [ '1.14+', '1.13', '1.12', '1.11', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
   en/ecs-logging/:
-    product: ecs_logging
+    product: ecs-logging
     legacy_versions: []
   en/ecs-logging/dotnet/:
-    product: ecs_dotnet
+    product: ecs-dotnet
     legacy_versions: []
   en/ecs-logging/go-logrus/:
-    product: ecs_logging_go_logrus
+    product: ecs-logging-go-logrus
     legacy_versions: []
   en/ecs-logging/go-zap/:
-    product: ecs_logging_go_zap
+    product: ecs-logging-go-zap
     legacy_versions: []
   en/ecs-logging/go-zerolog/:
-    product: ecs_logging_go_zerolog
+    product: ecs-logging-go-zerolog
     legacy_versions: []
   en/ecs-logging/java/:
-    product: ecs_logging_java
+    product: ecs-logging-java
     legacy_versions: ['0.x']
   en/ecs-logging/nodejs/:
-    product: ecs_logging_nodejs
+    product: ecs-logging-nodejs
     legacy_versions: []
   en/ecs-logging/overview/:
-    product: ecs_logging
+    product: ecs-logging
     legacy_versions: []
   en/ecs-logging/php/:
-    product: ecs_logging_php
+    product: ecs-logging-php
     legacy_versions: []
   en/ecs-logging/python/:
-    product: ecs_logging_python
+    product: ecs-logging-python
     legacy_versions: [ '2.2.0' ]
   en/ecs-logging/ruby/:
-    product: ecs_logging_ruby
+    product: ecs-logging-ruby
     legacy_versions: []
   en/ecs/:
     product: ecs
     legacy_versions: [ '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12', '8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '1.12', '1.11', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4', '1.3', '1.2', '1.1', '1.0' ]
   en/elastic-stack-glossary/:
-    product: elastic_stack
+    product: elastic-stack
     legacy_versions: []
   en/elastic-stack/:
-    product: elastic_stack
+    product: elastic-stack
     legacy_versions: *stack
   en/elasticsearch/client/curator/:
     product: curator
@@ -179,10 +179,10 @@ mappings:
     product: elasticsearch
     legacy_versions: *stack
   en/esf/:
-    product: elastic_serverless_forwarder
+    product: elastic-serverless-forwarder
     legacy_versions: ['1.20.1']
   en/fleet/:
-    product: elastic_agent
+    product: elastic-agent
     legacy_versions: *stack
   en/ingest-overview/:
     product: elasticsearch
@@ -215,7 +215,7 @@ mappings:
     product: elasticsearch
     legacy_versions: []
   en/search-ui/:
-    product: search_ui
+    product: search-ui
     legacy_versions: ['1.24.1', '1.24.0']
   en/security/:
     product: security

config/products.yml

@@ -2,46 +2,46 @@ products:
   apm:
     display: 'APM'
     versioning: 'stack'
-  apm_agent:
+  apm-agent:
     display: 'APM Agent'
     versioning: 'stack'
-  apm_agent_android:
+  apm-agent-android:
     display: 'APM Agent for Android'
     versioning: 'apm_agent_android'
-  apm_agent_dotnet:
+  apm-agent-dotnet:
     display: 'APM Agent for .NET'
     versioning: 'apm_agent_dotnet'
-  apm_agent_go:
+  apm-agent-go:
     display: 'APM Agent for Go'
     versioning: 'apm_agent_go'
-  apm_agent_ios:
+  apm-agent-ios:
     display: 'APM Agent for iOS'
     versioning: 'apm_agent_ios'
-  apm_agent_java:
+  apm-agent-java:
     display: 'APM Agent for Java'
     versioning: 'apm_agent_java'
-  apm_agent_node:
+  apm-agent-node:
     display: 'APM Agent for Node'
     versioning: 'apm_agent_node'
-  apm_agent_php:
+  apm-agent-php:
     display: 'APM Agent for PHP'
     versioning: 'apm_agent_php'
-  apm_agent_python:
+  apm-agent-python:
     display: 'APM Agent for Python'
     versioning: 'apm_agent_python'
-  apm_agent_ruby:
+  apm-agent-ruby:
     display: 'APM Agent for Ruby'
     versioning: 'apm_agent_ruby'
-  apm_agent_rum_js:
+  apm-agent-rum-js:
     display: 'APM RUM JavaScript agent'
     versioning: 'apm_agent_rum'
-  apm_k8s_attacher:
+  apm-k8s-attacher:
     display: 'APM Attacher for Kubernetes'
     versioning: 'apm_attacher'
-  apm_aws_lambda:
+  apm-aws-lambda:
     display: 'APM AWS Lambda extension'
     versioning: 'apm_lambda'
-  apm_server:
+  apm-server:
     display: 'APM Server'
     versioning: 'stack'
   auditbeat:
@@ -50,22 +50,22 @@ products:
   beats:
     display: 'Beats'
     versioning: 'stack'
-  cloud_control_ecctl:
+  cloud-control-ecctl:
     display: 'Elastic Cloud Control ECCTL'
     versioning: 'ecctl'
-  cloud_enterprise:
+  cloud-enterprise:
     display: 'Elastic Cloud Enterprise'
     versioning: 'ece'
-  cloud_hosted:
+  cloud-hosted:
     display: 'Elastic Cloud Hosted'
     versioning: 'ech'
-  cloud_kubernetes:
+  cloud-kubernetes:
     display: 'Elastic Cloud Kubernetes'
     versioning: 'eck'
-  cloud_serverless:
+  cloud-serverless:
     display: 'Elastic Cloud Serverless'
     versioning: 'serverless'
-  cloud_terraform:
+  cloud-terraform:
     display: 'Elastic Cloud Terraform'
     versioning: 'stack'
   curator:
@@ -74,85 +74,85 @@ products:
   ecs:
     display: 'Elastic Common Schema (ECS)'
     versioning: 'stack'
-  ecs_logging:
+  ecs-logging:
     display: 'ECS Logging'
     versioning: 'stack'
-  ecs_dotnet:
+  ecs-dotnet:
     display: 'Elastic Common Schema support for .NET'
     versioning: 'ecs_logging_dotnet'
-  ecs_logging_go_logrus:
+  ecs-logging-go-logrus:
     display: 'Elastic Common Schema (ECS) support for Logrus'
     versioning: 'ecs_logging_go_logrus'
-  ecs_logging_go_zap:
+  ecs-logging-go-zap:
     display: 'Elastic Common Schema (ECS) support for uber_go/zap logger'
     versioning: 'ecs_logging_go_zap'
-  ecs_logging_go_zerolog:
+  ecs-logging-go-zerolog:
     display: 'Elastic Common Schema (ECS) support for zerolog'
     versioning: 'ecs_logging_go_zerolog'
-  ecs_logging_java:
+  ecs-logging-java:
     display: 'ECS_based logging for Java applications'
     versioning: 'ecs_logging_java'
-  ecs_logging_nodejs:
+  ecs-logging-nodejs:
     display: 'Elastic Common Schema (ECS) support for Node js'
     versioning: 'ecs_logging_nodejs'
-  ecs_logging_php:
+  ecs-logging-php:
     display: 'ECS Logging for PHP'
     versioning: 'ecs_logging_php'
-  ecs_logging_python:
+  ecs-logging-python:
     display: 'Elastic Common Schema (ECS) support for Python'
     versioning: 'ecs_logging_python'
-  ecs_logging_ruby:
+  ecs-logging-ruby:
     display: 'Elastic Common Schema (ECS) support for Ruby'
     versioning: 'ecs_logging_ruby'
-  edot_cf:
+  edot-cf:
     display: 'EDOT Cloud Forwarder'
     versioning: 'stack'
-  edot_sdk:
+  edot-sdk:
     display: 'Elastic Distribution of OpenTelemetry SDK'
     versioning: 'stack'
-  edot_collector:
+  edot-collector:
     display: 'Elastic Distribution of OpenTelemetry Collector'
     versioning: 'stack'
-  edot_ios:
+  edot-ios:
     display: 'Elastic Distribution of OpenTelemetry iOS'
     versioning: 'edot_ios'
-  edot_android:
+  edot-android:
     display: 'Elastic Distribution of OpenTelemetry Android'
     versioning: 'edot_android'
-  edot_dotnet:
+  edot-dotnet:
     display: 'Elastic Distribution of OpenTelemetry .NET'
     versioning: 'edot_dotnet'
-  edot_java:
+  edot-java:
     display: 'Elastic Distribution of OpenTelemetry Java'
     versioning: 'edot_java'
-  edot_node:
+  edot-node:
     display: 'Elastic Distribution of OpenTelemetry Node'
     versioning: 'edot_node'
-  edot_php:
+  edot-php:
     display: 'Elastic Distribution of OpenTelemetry PHP'
     versioning: 'edot_php'
-  edot_python:
+  edot-python:
     display: 'Elastic Distribution of OpenTelemetry Python'
     versioning: 'edot_python'
-  edot_cf_aws:
+  edot-cf-aws:
     display: 'EDOT Cloud Forwarder for AWS'
     versioning: 'edot_cf_aws'
   eland:
     display: 'Eland'
     versioning: 'stack'
-  elastic_agent:
+  elastic-agent:
     display: 'Elastic Agent'
     versioning: 'stack'
-  elastic_serverless_forwarder:
+  elastic-serverless-forwarder:
     display: 'Elastic Serverless Forwarder'
     versioning: 'esf'
-  elastic_stack:
+  elastic-stack:
     display: 'Elastic Stack'
     versioning: 'stack'
   elasticsearch:
     display: 'Elasticsearch'
     versioning: 'stack'
-  elasticsearch_client:
+  elasticsearch-client:
     display: 'Elasticsearch Client'
     versioning: 'stack'
   ess:
@@ -176,7 +176,7 @@ products:
   logstash:
     display: 'Logstash'
     versioning: 'stack'
-  machine_learning:
+  machine-learning:
     display: 'Machine Learning'
     versioning: 'stack'
   metricbeat:
@@ -191,7 +191,7 @@ products:
   painless:
     display: 'Elasticsearch Painless scripting language'
     versioning: 'stack'
-  search_ui:
+  search-ui:
     display: 'Search UI'
     versioning: 'stack'
   security:
@@ -203,13 +203,13 @@ products:
   serverless:
     display: 'Elastic Serverless'
     versioning: 'all'
-  serverless_elasticsearch:
+  serverless-elasticsearch:
     display: 'Elasticsearch'
     versioning: 'all'
-  serverless_observability:
+  serverless-observability:
     display: 'Elastic Observability'
     versioning: 'all'
-  serverless_security:
+  serverless-security:
     display: 'Elastic Security'
     versioning: 'all'
   winlogbeat:

src/Elastic.Documentation.Configuration/Builder/ConfigurationFile.cs

@@ -149,7 +149,7 @@ public ConfigurationFile(IDocumentationSetContext context, VersionsConfiguration
 								break;
 							}
 
-							if (!productsConfig.Products.TryGetValue(productId.Value, out var productToAdd))
+							if (!productsConfig.Products.TryGetValue(productId.Value.Replace('_', '-'), out var productToAdd))
 								reader.EmitError($"Product \"{productId.Value}\" not found in the product list. {new Suggestion(productsConfig.Products.Select(p => p.Value.Id).ToHashSet(), productId.Value).GetSuggestionQuestion()}", node);
 							else
 								_ = Products.Add(productToAdd);