diff --git a/config/products.yml b/config/products.yml index 5c522f5f7..f762fe995 100644 --- a/config/products.yml +++ b/config/products.yml @@ -107,6 +107,9 @@ products: edot-node: display: 'Elastic Distribution of OpenTelemetry Node' repository: 'elastic-otel-node' + edot-browser: + display: 'Elastic Distribution of OpenTelemetry Browser (RUM)' + repository: 'elastic-otel-rum-js' edot-php: display: 'Elastic Distribution of OpenTelemetry PHP' repository: 'elastic-otel-php' diff --git a/config/versions.yml b/config/versions.yml index cf2115bb8..cdcc111d4 100644 --- a/config/versions.yml +++ b/config/versions.yml @@ -89,6 +89,9 @@ versioning_systems: edot-node: base: 1.0 current: 1.9.0 + edot-browser: + base: 0.1 + current: 0.1.0 edot-php: base: 1.0 current: 1.3.1 diff --git a/docs/_snippets/applies_to-key.md b/docs/_snippets/applies_to-key.md index ca1ac04c6..b9cc4d8c4 100644 --- a/docs/_snippets/applies_to-key.md +++ b/docs/_snippets/applies_to-key.md @@ -30,6 +30,7 @@ * `edot_ios`: Applies to the [Elastic Distribution of OpenTelemetry iOS](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/ios/) (EDOT iOS). * `edot_java`: Applies to the [Elastic Distribution of OpenTelemetry Java](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/java/) (EDOT Java). * `edot_node`: Applies to the [Elastic Distribution of OpenTelemetry Node.js](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/nodejs/) (EDOT Node.js). + * `edot_browser`: Applies to the [Elastic Distribution of OpenTelemetry Browser (RUM)](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/rum-js/) (EDOT Browser). * `edot_php`: Applies to the [Elastic Distribution of OpenTelemetry PHP](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/php/) (EDOT PHP). * `edot_python`: Applies to the [Elastic Distribution of OpenTelemetry Python](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/python/) (EDOT Python). diff --git a/docs/syntax/version-variables.md b/docs/syntax/version-variables.md index f841d63a6..8edf0016d 100644 --- a/docs/syntax/version-variables.md +++ b/docs/syntax/version-variables.md @@ -103,6 +103,7 @@ This is dictated by the [`versions.yml`](https://github.com/elastic/docs-builder * `edot_dotnet` * `edot_java` * `edot_node` +* `edot_browser` * `edot_php` * `edot_python` * `edot_cf_aws` diff --git a/src/Elastic.Documentation.Configuration/Versions/VersionConfiguration.cs b/src/Elastic.Documentation.Configuration/Versions/VersionConfiguration.cs index 8ff0a3ed2..697e8e411 100644 --- a/src/Elastic.Documentation.Configuration/Versions/VersionConfiguration.cs +++ b/src/Elastic.Documentation.Configuration/Versions/VersionConfiguration.cs @@ -105,6 +105,8 @@ public enum VersioningSystemId EdotJava, [Display(Name = "edot-node")] EdotNode, + [Display(Name = "edot-browser")] + EdotBrowser, [Display(Name = "edot-php")] EdotPhp, [Display(Name = "edot-python")] diff --git a/src/Elastic.Documentation/AppliesTo/ApplicableToYamlConverter.cs b/src/Elastic.Documentation/AppliesTo/ApplicableToYamlConverter.cs index 91fe52b57..2c1c333db 100644 --- a/src/Elastic.Documentation/AppliesTo/ApplicableToYamlConverter.cs +++ b/src/Elastic.Documentation/AppliesTo/ApplicableToYamlConverter.cs @@ -231,6 +231,7 @@ private static bool TryGetProductApplicability(Dictionary dicti { "edot_dotnet", a => productAvailability.EdotDotnet = a }, { "edot_java", a => productAvailability.EdotJava = a }, { "edot_node", a => productAvailability.EdotNode = a }, + { "edot_browser", a => productAvailability.EdotBrowser = a }, { "edot_php", a => productAvailability.EdotPhp = a }, { "edot_python", a => productAvailability.EdotPython = a }, { "edot_cf_aws", a => productAvailability.EdotCfAws = a }, diff --git a/src/Elastic.Documentation/AppliesTo/ProductApplicability.cs b/src/Elastic.Documentation/AppliesTo/ProductApplicability.cs index 886f6a62e..c486bcf47 100644 --- a/src/Elastic.Documentation/AppliesTo/ProductApplicability.cs +++ b/src/Elastic.Documentation/AppliesTo/ProductApplicability.cs @@ -61,6 +61,9 @@ public record ProductApplicability [YamlMember(Alias = "edot-node")] public AppliesCollection? EdotNode { get; set; } + [YamlMember(Alias = "edot-browser")] + public AppliesCollection? EdotBrowser { get; set; } + [YamlMember(Alias = "edot-php")] public AppliesCollection? EdotPhp { get; set; } @@ -112,6 +115,7 @@ void AppendProduct(string name, AppliesCollection? value) AppendProduct("edot-dotnet", EdotDotnet); AppendProduct("edot-java", EdotJava); AppendProduct("edot-node", EdotNode); + AppendProduct("edot-browser", EdotBrowser); AppendProduct("edot-php", EdotPhp); AppendProduct("edot-python", EdotPython); AppendProduct("edot-cf-aws", EdotCfAws); @@ -144,6 +148,7 @@ public static class ProductApplicabilityConversion { EdotDotnet: not null } => "edot-dotnet", { EdotJava: not null } => "edot-java", { EdotNode: not null } => "edot-node", + { EdotBrowser: not null } => "edot-browser", { EdotPhp: not null } => "edot-php", { EdotPython: not null } => "edot-python", { EdotCfAws: not null } => "edot-cf-aws", diff --git a/src/Elastic.Markdown/Myst/Components/ApplicabilityMappings.cs b/src/Elastic.Markdown/Myst/Components/ApplicabilityMappings.cs index 13407f18b..d20e291c4 100644 --- a/src/Elastic.Markdown/Myst/Components/ApplicabilityMappings.cs +++ b/src/Elastic.Markdown/Myst/Components/ApplicabilityMappings.cs @@ -39,6 +39,7 @@ public record ApplicabilityDefinition(string Key, string DisplayName, Versioning public static readonly ApplicabilityDefinition EdotIos = new("EDOT iOS", "Elastic Distribution of OpenTelemetry iOS", VersioningSystemId.EdotIos); public static readonly ApplicabilityDefinition EdotJava = new("EDOT Java", "Elastic Distribution of OpenTelemetry Java", VersioningSystemId.EdotJava); public static readonly ApplicabilityDefinition EdotNode = new("EDOT Node.js", "Elastic Distribution of OpenTelemetry Node.js", VersioningSystemId.EdotNode); + public static readonly ApplicabilityDefinition EdotBrowser = new("EDOT Browser", "Elastic Distribution of OpenTelemetry Browser (RUM)", VersioningSystemId.EdotBrowser); public static readonly ApplicabilityDefinition EdotPhp = new("EDOT PHP", "Elastic Distribution of OpenTelemetry PHP", VersioningSystemId.EdotPhp); public static readonly ApplicabilityDefinition EdotPython = new("EDOT Python", "Elastic Distribution of OpenTelemetry Python", VersioningSystemId.EdotPython); diff --git a/src/Elastic.Markdown/Myst/Components/ApplicableToViewModel.cs b/src/Elastic.Markdown/Myst/Components/ApplicableToViewModel.cs index ffe651543..d3ca01921 100644 --- a/src/Elastic.Markdown/Myst/Components/ApplicableToViewModel.cs +++ b/src/Elastic.Markdown/Myst/Components/ApplicableToViewModel.cs @@ -43,6 +43,7 @@ public class ApplicableToViewModel [p => p.EdotIos] = ApplicabilityMappings.EdotIos, [p => p.EdotJava] = ApplicabilityMappings.EdotJava, [p => p.EdotNode] = ApplicabilityMappings.EdotNode, + [p => p.EdotBrowser] = ApplicabilityMappings.EdotBrowser, [p => p.EdotPhp] = ApplicabilityMappings.EdotPhp, [p => p.EdotPython] = ApplicabilityMappings.EdotPython, [p => p.ApmAgentAndroid] = ApplicabilityMappings.ApmAgentAndroid, diff --git a/src/Elastic.Markdown/Myst/Components/ProductDescriptions.cs b/src/Elastic.Markdown/Myst/Components/ProductDescriptions.cs index 0a5fa3496..bee9e8a7c 100644 --- a/src/Elastic.Markdown/Myst/Components/ProductDescriptions.cs +++ b/src/Elastic.Markdown/Myst/Components/ProductDescriptions.cs @@ -172,6 +172,11 @@ bool IncludeVersionNote AdditionalAvailabilityInfo: null, IncludeVersionNote: true ), + [VersioningSystemId.EdotBrowser] = new ProductInfo( + Description: "The Elastic Distribution of OpenTelemetry (EDOT) Browser SDK (RUM) collects performance metrics, traces, and logs from web applications in OpenTelemetry format, and sends them to Elastic Observability.", + AdditionalAvailabilityInfo: null, + IncludeVersionNote: true + ), [VersioningSystemId.EdotPhp] = new ProductInfo( Description: "The Elastic Distribution of OpenTelemetry (EDOT) PHP SDK collects performance metrics, traces, and logs in OpenTelemetry format, and sends them to Elastic Observability.", AdditionalAvailabilityInfo: null, diff --git a/tests/Elastic.Documentation.Configuration.Tests/VersionInferenceTests.cs b/tests/Elastic.Documentation.Configuration.Tests/VersionInferenceTests.cs index bb8a6283a..1280df803 100644 --- a/tests/Elastic.Documentation.Configuration.Tests/VersionInferenceTests.cs +++ b/tests/Elastic.Documentation.Configuration.Tests/VersionInferenceTests.cs @@ -37,6 +37,7 @@ public class VersionInferenceTests { nameof(ProductApplicability.EdotDotnet), "edot-dotnet" }, { nameof(ProductApplicability.EdotJava), "edot-java" }, { nameof(ProductApplicability.EdotNode), "edot-node" }, + { nameof(ProductApplicability.EdotBrowser), "edot-browser" }, { nameof(ProductApplicability.EdotPhp), "edot-php" }, { nameof(ProductApplicability.EdotPython), "edot-python" }, { nameof(ProductApplicability.EdotCfAws), "edot-cf-aws" }, @@ -88,6 +89,7 @@ private static ProductsConfiguration CreateProductsConfiguration(VersionsConfigu { "edot-dotnet", VersioningSystemId.EdotDotnet }, { "edot-java", VersioningSystemId.EdotJava }, { "edot-node", VersioningSystemId.EdotNode }, + { "edot-browser", VersioningSystemId.EdotBrowser }, { "edot-php", VersioningSystemId.EdotPhp }, { "edot-python", VersioningSystemId.EdotPython }, { "edot-cf-aws", VersioningSystemId.EdotCfAws }, @@ -171,6 +173,9 @@ private static ProductApplicability CreateProductApplicabilityByName(string prod case nameof(ProductApplicability.EdotNode): applicability.EdotNode = value; break; + case nameof(ProductApplicability.EdotBrowser): + applicability.EdotBrowser = value; + break; case nameof(ProductApplicability.EdotPhp): applicability.EdotPhp = value; break;