Product Configuration #1865

cotti · 2025-09-10T09:29:58Z

Handles #1637

This PR performs a few refactorings into how we deal with product, versioning and legacy URL mapping definitions.

Configuration

Substitutions have been added for products to access their labels.
Initialization for products.yml and legacy-url-mappings.yml occurs during early service bootstrapping.

Products Listing

We now have a products.yml file to gather essential product metadata. Currently, we have a friendly label for each, and reference the versioning system adopted by the project in question.

Versioning

Updated to leverage the connection between Product/Version/LegacyURL.

Legacy Url Mapping

legacy-url-mappings.yml has been reviewed to include a reference to a product. Most entries have a direct correlation. For a few cases, a best-match approach was taken.

Docs

Docs-builder's documentation was updated to reflect these changes.

…roduct metadata, and substitution support for them

…roducts.yml

# Conflicts: # config/legacy-url-mappings.yml # src/tooling/docs-assembler/Cli/RepositoryCommands.cs

config/legacy-url-mappings.yml

theletterf

@elastic/docs-engineering I think this PR would also solve #1497

What happens with existing product subs define in docset.yml files, by the way? Should we prefer products.yml driven substitutions from now on?

docs/configure/site/products.md

Mpdreamz

A few small nits and q's.

Would be good to include more tests on resolving product names and their attached versioning schemes.

docs/configure/site/products.md

docs/syntax/version-variables.md

src/tooling/docs-assembler/AssembleSources.cs

src/Elastic.Documentation.Configuration/Products/Product.cs

src/Elastic.Documentation.Configuration/ConfigurationFileProvider.cs

Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>

docs/configure/site/products.md

Fabrizio with the save. Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>

reakaleek · 2025-09-10T10:14:28Z

Smoke tests are failing. We should run a full assembler build to validate.

florent-leborgne

I think we're adding possible confusion points in the products.yml file with duplicates or nearly duplicate entries. LMK what you think.

config/products.yml

Co-authored-by: florent-leborgne <[email protected]>

…ture/product_config

…url mappings

config/products.yml

shainaraskas · 2025-09-12T19:29:11Z

What happens with existing product subs define in docset.yml files, by the way? Should we prefer products.yml driven substitutions from now on?

I share this confusion - can we maybe reference these in docset.yml so we can keep using the same variables?

shainaraskas

threw some comments on where I could. I suggested a couple of terminology fixes and version # fixes

I'd like to better understand how this actually impacts the functionality of the dropdown - maybe a quick demo could be helpful, or even just explaining using an image of the dropdown what info is populated from where. want to understand what is actually changing with the experience based on these changes

shainaraskas · 2025-09-12T19:59:25Z

config/products.yml

+    display: 'Elastic Cloud Serverless'
+    versioning: 'serverless'
+  cloud-terraform:
+    display: 'Elastic Cloud Terraform'


we don't have any docs about this product really but I don't think it's stack versioned

https://github.com/elastic/terraform-provider-elasticstack

Suggested change

display: 'Elastic Cloud Terraform'

display: 'Elastic Cloud Terraform provider'

shainaraskas · 2025-09-12T19:59:40Z

config/products.yml

+    display: 'Elastic Cloud Hosted'
+    versioning: 'ech'
+  cloud-kubernetes:
+    display: 'Elastic Cloud Kubernetes'


Suggested change

display: 'Elastic Cloud Kubernetes'

display: 'Elastic Cloud on Kubernetes'

shainaraskas · 2025-09-12T19:59:57Z

config/products.yml

+    display: 'Beats'
+    versioning: 'stack'
+  cloud-control-ecctl:
+    display: 'Elastic Cloud Control ECCTL'


Suggested change

display: 'Elastic Cloud Control ECCTL'

display: 'Elastic Cloud Control'

shainaraskas · 2025-09-12T20:01:49Z

config/products.yml

+    display: 'Elasticsearch Curator'
+    versioning: 'curator'
+  ecs:
+    display: 'Elastic Common Schema (ECS)'


do we want brackets on these? @colleenmcginnis

shainaraskas · 2025-09-12T20:03:04Z

config/products.yml

+    display: 'Elastic Common Schema (ECS) support for zerolog'
+    versioning: 'ecs_logging_go_zerolog'
+  ecs-logging-java:
+    display: 'ECS_based logging for Java applications'


this one looks wrong?

also, not seeing this full name used in the libraries docs, e.g. https://www.elastic.co/docs/reference/ecs/logging/java

@colleenmcginnis

Suggested change

display: 'ECS_based logging for Java applications'

display: 'ECS-based logging for Java applications'

shainaraskas · 2025-09-12T20:11:03Z

config/legacy-url-mappings.yml

+    legacy_versions: *stack
+  en/elasticsearch/client/curator/:
+    product: curator
+    legacy_versions: [ '8.0.21', '7.0', '6.0', '5.8', '5.7', '5.6', '5.5', '5.4', '5.3', '5.2', '5.1', '5.0', '4.3', '4.2', '4.1', '4.0', '3.5', '3.4', '3.3' ]


8.0.21 is current for curator

shainaraskas · 2025-09-12T20:12:36Z

config/legacy-url-mappings.yml

+    product: elastic-agent
+    legacy_versions: *stack
+  en/ingest-overview/:
+    product: elasticsearch


not elasticsearch

shainaraskas · 2025-09-12T20:12:42Z

config/legacy-url-mappings.yml

+    product: elasticsearch
+    legacy_versions: []
+  en/ingest/:
+    product: elasticsearch


not elasticsearch

shainaraskas · 2025-09-12T20:13:07Z

config/legacy-url-mappings.yml

+    product: logstash
+    legacy_versions: *stack
+  en/machine-learning/:
+    product: elasticsearch


we have a unique product for this although I would argue that it is elasticsearch

shainaraskas · 2025-09-12T20:13:14Z

config/legacy-url-mappings.yml

+    product: cloud-serverless
+    legacy_versions: []
+  en/starting-with-the-elasticsearch-platform-and-its-solutions/:
+    product: elasticsearch


not elasticsearch

cotti added 10 commits September 3, 2025 11:09

Introduce products.yml as the central resource to catalogue primary p…

39befc6

…roduct metadata, and substitution support for them

Adjust legacy URL mapping to use Product metadata

a2ebf39

Merge branch 'main' into feature/product_config

d663ede

Refactor legacy-url-mappings.yml, update values on versions.yml and p…

9521c8a

…roducts.yml

Merge branch 'main' into feature/product_config

752f80d

# Conflicts: # config/legacy-url-mappings.yml # src/tooling/docs-assembler/Cli/RepositoryCommands.cs

Fix merge

c9a7ec3

Refactor location of Product

d328e32

Fix property definition

6361eb1

Refactor loading Product and LegacyUrlMapping data

1ddfa3e

Add documentation

ed9aeb1

cotti self-assigned this Sep 10, 2025

cotti requested a review from a team as a code owner September 10, 2025 09:29

cotti added the feature label Sep 10, 2025

cotti requested review from a team as code owners September 10, 2025 09:29

cotti requested a review from Mpdreamz September 10, 2025 09:30

github-actions bot deployed to docs-preview September 10, 2025 09:30 View deployment

theletterf requested a review from colleenmcginnis September 10, 2025 09:36

reakaleek reviewed Sep 10, 2025

View reviewed changes

config/legacy-url-mappings.yml Outdated Show resolved Hide resolved

theletterf reviewed Sep 10, 2025

View reviewed changes

docs/configure/site/products.md Outdated Show resolved Hide resolved

docs/configure/site/products.md Outdated Show resolved Hide resolved

cotti added 2 commits September 10, 2025 06:54

Fix legacy version lists with 9.0+ entries

626c199

Standardize with underscores

806259e

Mpdreamz requested changes Sep 10, 2025

View reviewed changes

github-actions bot had a problem deploying to docs-preview September 10, 2025 09:57 Failure

Update docs/configure/site/products.md

0434e00

Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>

github-actions bot deployed to docs-preview September 10, 2025 10:00 View deployment

theletterf reviewed Sep 10, 2025

View reviewed changes

docs/configure/site/products.md Outdated Show resolved Hide resolved

Update docs/configure/site/products.md

d4a2167

Fabrizio with the save. Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>

github-actions bot deployed to docs-preview September 10, 2025 10:11 View deployment

cotti added 2 commits September 10, 2025 12:44

Standardize on underscores as it is more widely used by writers

7ee832e

Merge branch 'main' into feature/product_config

9ba7cf7

github-actions bot deployed to docs-preview September 10, 2025 15:45 View deployment

florent-leborgne reviewed Sep 10, 2025

View reviewed changes

config/products.yml Outdated Show resolved Hide resolved

config/products.yml Outdated Show resolved Hide resolved

config/products.yml Outdated Show resolved Hide resolved

cotti and others added 2 commits September 11, 2025 09:47

Merge branch 'main' into feature/product_config

4559374

Update config/products.yml

1234a84

Co-authored-by: florent-leborgne <[email protected]>

github-actions bot deployed to docs-preview September 11, 2025 14:39 View deployment

cotti added 5 commits September 11, 2025 11:53

Merge remote-tracking branch 'origin/feature/product_config' into fea…

84e9be7

…ture/product_config

Remove obsolete EqualityComparer

8f7e77d

Adjust product listing

0175253

Minor clean-ups

4627aec

Adding non-product entries back

a69fa1e

github-actions bot deployed to docs-preview September 11, 2025 15:14 View deployment

Remove duplicate version entries between versions.yml and the legacy …

a0c2bc1

…url mappings

github-actions bot had a problem deploying to docs-preview September 11, 2025 15:19 Failure

Merge branch 'main' into feature/product_config

43b9561

github-actions bot deployed to docs-preview September 11, 2025 15:20 View deployment

FIx tests and ecctl definition

f064443

github-actions bot deployed to docs-preview September 12, 2025 02:18 View deployment

reakaleek reviewed Sep 12, 2025

View reviewed changes

config/products.yml Show resolved Hide resolved

cotti added 2 commits September 12, 2025 12:14

Use a static deserializer through the same assembly

daa393c

Adjust product id for ecctl and fix flexibility rules

741c1ec

github-actions bot deployed to docs-preview September 12, 2025 15:17 View deployment

Support underscores and dashes in substitutions

2372b84

github-actions bot deployed to docs-preview September 12, 2025 15:54 View deployment

Merge branch 'main' into feature/product_config

d395917

github-actions bot deployed to docs-preview September 12, 2025 16:27 View deployment

cotti requested a review from Mpdreamz September 12, 2025 16:31

shainaraskas reviewed Sep 12, 2025

View reviewed changes

	display: 'Elastic Cloud Terraform'
	display: 'Elastic Cloud Terraform provider'

	display: 'Elastic Cloud Kubernetes'
	display: 'Elastic Cloud on Kubernetes'

	display: 'Elastic Cloud Control ECCTL'
	display: 'Elastic Cloud Control'

	display: 'ECS_based logging for Java applications'
	display: 'ECS-based logging for Java applications'

Product Configuration #1865

Are you sure you want to change the base?

Product Configuration #1865

Uh oh!

Conversation

cotti commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Configuration

Products Listing

Versioning

Legacy Url Mapping

Docs

Uh oh!

Uh oh!

theletterf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Mpdreamz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

reakaleek commented Sep 10, 2025

Uh oh!

florent-leborgne left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shainaraskas commented Sep 12, 2025

Uh oh!

shainaraskas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cotti commented Sep 10, 2025 •

edited

Loading