Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
1 of 4 tasks
dbwiddis opened this issue Nov 11, 2024 · 1 comment · Fixed by #8702
Closed
1 of 4 tasks

Comments

@dbwiddis
Copy link
Member

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

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
Copy link
Member Author

dbwiddis commented Nov 11, 2024

It looks like at least one rendered properly with

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

I'll get a PR up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant