Related product metadata per operation

[georgewallace]

🚀 Feature Proposal

To support our site and doumentation search we need the ability to tag each page of our documentation with a product label from the following list. https://elastic.github.io/docs-builder/syntax/frontmatter/#products

Motivation

Adding this metadata will allow us to add a META header tag to each page so that our site search ran by the web team can pick it up and add the facet to search and allow customers filtering content on e.g elasticsearch, to only see content related to Elasticsearch.

Example

We would use the product extension to populate the meta class elastic, product, name with the products that are related. An example of that tag can be seen on an existing piece of documentation.

[georgewallace]

I can't find the earlier issue created for this so opening a new one.

the following are the Distinct tags found in the Elasticsearch OpenAPI spec

{'health_report', 'security', 'ilm', 'data stream', 'ccr', 'inference', 'cluster', 'enrich', 'ml data frame', 'transform', 'license', 'ml', 'fleet', 'document', 'tasks', 'rollup', 'graph', 'cat', 'migration', 'xpack', 'features', 'ml anomaly', 'esql', 'snapshot', 'watcher', 'shutdown', 'sql', 'searchable_snapshots', 'text_structure', 'info', 'ml trained model', 'ingest', 'search', 'slm', 'indices', 'autoscaling', 'logstash', 'query_rules', 'script', 'eql', 'search_application', 'analytics', 'synonyms', 'connector'}

One potential solution would be to define a mapping of these tag values to values from the Products list shared earlier.

[georgewallace]

After further ideation with Sylvain, the idea would be

1. Add into the OpenAPI generation (for docs) logic to add a property to each operation that adds a extension product, x-product-feature that's value is elasticsearch as all calls within the elasticsearch specification relate to elasticsearch
2. Leverage a configuration file to address any additional product names (derived from https://elastic.github.io/docs-builder/syntax/frontmatter/#products) to the appropriate folder operations. This configuration file could be defined at the top level, i.e ml, or a sub level ml.close_job. By defining this structure we can keep the configuration file to a minimum set of values while still being able to be selective on the product name that we would add to an operation. The following is a potential example of what this configuration file could look like. These values would be appended to the x-product-feature property so for ml.close_job it would be x-product-feature: "elasticsearch, machine-learning for example. @lcawl @szabosteve please make any suggestions to this as you see fit. FYI @swallez

{
"ml.close_job" : "machine-learning",
"logstash" : "logstash",
"fleet" : "fleet"
}

[swallez]

@l-trotta this is what we discussed earlier. Can you look at it? Not sure where to put this config file, specification/_doc_ids seems like a good place (let's avoid spreading docs-related things in too many places).