docs-builder products.yml
The products.yml file specifies metadata regarding the projects in the organization that use the V3 docs system.
products: apm-agent-dotnet: display: 'APM .NET Agent' versioning: 'apm-agent-dotnet' edot-collector: display: 'Elastic Distribution of OpenTelemetry Collector' versioning: 'stack' #... products-
A YAML mapping where each key is an Elastic product.
display: A friendly name for the product.versioning: The versioning system used by the project. The value for this field must match one of the versioning systems defined inversions.yml
Writing {{ product.<product-id> }} renders the friendly name of the product in the documentation. For example:
| Substitution | Result |
|---|---|
{{ product.apm-agent-dotnet }} | APM .NET Agent |
{{ product.edot-collector }} | Elastic Distribution of OpenTelemetry Collector |
You can also use the shorthand notation {{ .<product_id> }}. For example:
| Substitution | Result |
|---|---|
{{ .apm-agent-dotnet }} | APM .NET Agent |
{{ .edot-collector }} | Elastic Distribution of OpenTelemetry Collector |
Note
While the recommended separator is a hyphen (-) to promote cohesion, underscores (_) are also supported, and internally read as hyphens.