Skip to content

[DOC] Updates to Render template page #7706

@kolchfa-aws

Description

@kolchfa-aws

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. Provide a summary of the request.
There are several things that need to be addressed on the Render template API page (and the related multi-search template page and search templates page:

  • The existing search templates page contains information about render template and multi-search template. These 3 pages need to be deduped and info needs reconciliation.
  • All 3 pages need to be under the same section (probably search templates is the parent and the other two are its children)
  • The left navigation needs to be correctly capitalized
  • Capitalization: capitalize only the first word in Render template and Multi-search template
  • Mustache variables: escape all Mustache variables with raw/endraw tags to avoid liquid warning and the variable not displaying on the site
  • Add copy-curl buttons instead of copy buttons
  • The section names should be according to the API template
  • Add json highlighting to API requests/responses
  • Example response: make heading level 4 and remove the intro sentence

*Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
All
What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Metadata

Metadata

Assignees

Labels

Backlog - DOCDoc writer assigned to issue responsible for creating PR.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions