Remove html tag escaping in chapter-single-definition.tmpl #47089
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is part of a two-PR solution to address issue #35712: Code blocks not rendering properly in API Documentation (Quantity).
Current problem:
The Quantity description in the Kubernetes API documentation contains a code block that is not being rendered correctly. Instead of proper formatting, the code is displayed as a single line, making it difficult to read and understand.
Proposed solution:
This PR, along with a companion PR in the kubernetes-sigs/reference-docs repository, aims to improve the rendering of code blocks within the API documentation, specifically targeting the Quantity resource description.
Current status:
Known limitation:
The following lines are still rendered on a single line due to newline characters not being captured in the Swagger JSON:
Seeking feedback:
I'm looking for input on whether this approach is the right direction to solve the issue. Specifically:
Screenshots:
Companion PRs:
kubernetes-sigs/reference-docs#365
Any feedback or suggestions for improvement are greatly appreciated. Thank you for your time and input!