-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
Remove html tag escaping in chapter-single-definition.tmpl #47089
base: main
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
I think the fix to the OpenAPI generation (preserving newlines) should happen in k/k |
+1, more specifically in the OpenAPI generation most likely in k/kube-openapi. That only solves 3 though, so this PR and kubernetes-sigs/reference-docs#365 are still necessary to make everything fit together. |
af9a9c3
to
6c35a50
Compare
6c35a50
to
d91fa4c
Compare
PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
@robert-cronin Getting this fixed properly is likely to mean more coordination work (working across different code repositories). Does that work suit you? If not, we may not be able to help with just this part of the bigger picture. There are a lot of improvements we could make and we need to focus our efforts where they are most effective. |
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!