opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
74 stars 489 forks source link

[DOC] Substitution template syntax on Provisioning Workflow API doesn't render properly #8701

Closed dbwiddis closed 1 day ago

dbwiddis commented 2 days ago

What do you want to do?

Tell us about your request.

The rendered version of the Provision Workflow API shows a substitution template as simply '$', see https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/

The intended substitution template includes curly braces, such as '${{ openai_key }}, see https://github.com/opensearch-project/documentation-website/blob/main/_automating-configurations/api/provision-workflow.md

A similar error occurs on the Create Workflow API page, see https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/ with markdown https://github.com/opensearch-project/documentation-website/blob/main/_automating-configurations/api/create-workflow.md

I'm guessing the quoted curly braces run afoul of some rendering magic and need to be escaped.

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.

2.13--current.

dbwiddis commented 2 days ago

It looks like at least one rendered properly with

{% raw %}`${{ <value> }}`{% endraw %}

I'll get a PR up.