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

Render code blocks properly in OpenAPI #482

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Jefftree
Copy link
Member

@Jefftree Jefftree commented Jul 4, 2024

Render code blocks properly in OpenAPI.

Partially solves kubernetes/website#35712

/cc @sftim @robert-cronin
/assign @jpbetz @sttts

k/k OpenAPI diff can be seen here kubernetes/kubernetes@7e24dab#diff-9f4c1466e676f9e733cae72d369ffd5ff37f446116c98562807cf3bfb872ae95

@k8s-ci-robot
Copy link
Contributor

@Jefftree: GitHub didn't allow me to request PR reviews from the following users: robert-cronin.

Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Render code blocks properly in OpenAPI.

Partially solves kubernetes/website#35712

/cc @sftim @robert-cronin
/assign @jpbetz @sttts

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.

@k8s-ci-robot k8s-ci-robot requested a review from sftim July 4, 2024 15:18
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 4, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Jefftree

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 4, 2024
Copy link

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Do we want to handle code blocks inside block quotes? I imagine not, but we might do. Calling this out as a case we could choose to handle.

@Jefftree
Copy link
Member Author

Jefftree commented Jul 4, 2024

The motivation was code blocks but imo anything within the block quote ``` should NOT be interpreted as markdown and should be outputted as is with no reformatting done. That's essentially what this PR is targeting

@sftim
Copy link

sftim commented Jul 4, 2024

Markdown blockquotes look like:

> This is a block quote
> 
> Within the block quote there could be a multiline code snippet
> ```
> echo "Hello, world
> ```

@Jefftree
Copy link
Member Author

Jefftree commented Jul 4, 2024

Ah sorry I mixed up the terminology.

I'm not sure if we have any examples of use cases with blockquotes, so right now I'm leaning probably not. We can re-evaluate if we see a future use case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants