Product Configuration #1865
Merged
Product Configuration #1865
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…roduct metadata, and substitution support for them
# Conflicts: # config/legacy-url-mappings.yml # src/tooling/docs-assembler/Cli/RepositoryCommands.cs
reakaleek
reviewed
Sep 10, 2025
theletterf
reviewed
Sep 10, 2025
There was a problem hiding this comment.
@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?
Mpdreamz
requested changes
Sep 10, 2025
src/Elastic.Documentation.Configuration/ConfigurationFileProvider.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
theletterf
reviewed
Sep 10, 2025
Fabrizio with the save. Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
|
Smoke tests are failing. We should run a full assembler build to validate. |
There was a problem hiding this comment.
Pull Request Overview
This PR refactors how the documentation system handles product configuration, versioning, and legacy URL mapping definitions by introducing a new products.yml configuration file and updating the configuration architecture.
- Introduces a centralized
products.ymlfile for product metadata including display names and versioning systems - Refactors legacy URL mappings to reference products instead of raw version lists
- Updates configuration initialization to load products and legacy mappings during service bootstrap
Reviewed Changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| config/products.yml | New configuration file defining all product metadata with display names and versioning systems |
| config/legacy-url-mappings.yml | Updated to reference products from products.yml instead of direct version arrays |
| src/Elastic.Documentation.Configuration/Products/ | New product configuration classes and extensions for handling product metadata |
| src/Elastic.Documentation.Configuration/LegacyUrlMappings/ | New legacy URL mapping configuration classes replacing the old Legacy namespace |
| Multiple test files | Updated test helpers to include new ProductsConfiguration and LegacyUrlMappingConfiguration dependencies |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Are there any changes needed due to #1932? |
|
@cotti @reakaleek Yeah, we'll need to add |
# Conflicts: # config/versions.yml # src/Elastic.Documentation.Configuration/ConfigurationFileProvider.cs # src/Elastic.Documentation.LegacyDocs/PageLegacyUrlMapper.cs # src/Elastic.Documentation/AppliesTo/ApplicableToYamlConverter.cs # src/services/Elastic.Documentation.Assembler/AssembleSources.cs # src/tooling/docs-assembler/Cli/RepositoryCommands.cs # tests/Elastic.ApiExplorer.Tests/TestHelpers.cs # tests/Elastic.Markdown.Tests/TestHelpers.cs # tests/authoring/Framework/Setup.fs
theletterf
reviewed
Sep 25, 2025
# Conflicts: # config/legacy-url-mappings.yml
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
…ture/product_config
Mpdreamz
reviewed
Sep 25, 2025
Mpdreamz
approved these changes
Sep 25, 2025
Mpdreamz
reviewed
Sep 25, 2025
lcawl
reviewed
Sep 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Handles #1637
This PR performs a few refactorings into how we deal with product, versioning and legacy URL mapping definitions.
Configuration
products.ymlandlegacy-url-mappings.ymloccurs during early service bootstrapping.Products Listing
products.ymlfile 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
Legacy Url Mapping
legacy-url-mappings.ymlhas 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