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

Properly render documentation with double curly braces #8702

Merged

Conversation

dbwiddis
Copy link
Member

Description

Substitution parameters in the Automating Configurations documentation use double curly braces, like ${{ foo }}. This requires escaping to properly render on the documentation page.

Issues Resolved

Closes #8701

Version

2.13 to present

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: Daniel Widdis <widdis@gmail.com>
@dbwiddis dbwiddis force-pushed the fix-substitution-escaping branch from 10aee43 to e4ad3b2 Compare November 11, 2024 04:25
@dbwiddis dbwiddis added the 4 - Doc review PR: Doc review in progress label Nov 11, 2024
@dbwiddis
Copy link
Member Author

@kolchfa-aws skipped tech review since no change to technical content, just a rendering issue.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this, @dbwiddis. LGTM

@kolchfa-aws kolchfa-aws added backport 2.13 PR: Backport label for 2.13 backport 2.14 PR: Backport label for 2.14 backport 2.15 backport 2.16 backport 2.17 Backport for version 2.17 backport 2.18 PR: Backport label for 2.18 labels Nov 11, 2024
@kolchfa-aws kolchfa-aws merged commit e6fdad4 into opensearch-project:main Nov 11, 2024
13 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 11, 2024
Signed-off-by: Daniel Widdis <widdis@gmail.com>
(cherry picked from commit e6fdad4)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 11, 2024
Signed-off-by: Daniel Widdis <widdis@gmail.com>
(cherry picked from commit e6fdad4)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 11, 2024
Signed-off-by: Daniel Widdis <widdis@gmail.com>
(cherry picked from commit e6fdad4)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 11, 2024
Signed-off-by: Daniel Widdis <widdis@gmail.com>
(cherry picked from commit e6fdad4)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 11, 2024
Signed-off-by: Daniel Widdis <widdis@gmail.com>
(cherry picked from commit e6fdad4)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 11, 2024
Signed-off-by: Daniel Widdis <widdis@gmail.com>
(cherry picked from commit e6fdad4)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
…oject#8702)

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.13 PR: Backport label for 2.13 backport 2.14 PR: Backport label for 2.14 backport 2.15 backport 2.16 backport 2.17 Backport for version 2.17 backport 2.18 PR: Backport label for 2.18
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Substitution template syntax on Provisioning Workflow API doesn't render properly
2 participants