kube-openapi icon indicating copy to clipboard operation
kube-openapi copied to clipboard

Published 20 hours ago • verified publisher icon kubernetes

Render code blocks properly in OpenAPI

Open Jefftree opened this issue 1 year ago • 11 comments
trafficstars

Render code blocks properly in OpenAPI.

Partially solves https://github.com/kubernetes/website/issues/35712

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

k/k OpenAPI diff can be seen here https://github.com/kubernetes/kubernetes/pull/125899/commits/7e24dabdd9b84c67f2f2aa1445d53be6bddefb7e#diff-9f4c1466e676f9e733cae72d369ffd5ff37f446116c98562807cf3bfb872ae95

Jefftree avatar Jul 04 '24 15:07 Jefftree

@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 https://github.com/kubernetes/website/issues/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 avatar Jul 04 '24 15:07 k8s-ci-robot

[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 avatar Jul 04 '24 15:07 k8s-ci-robot

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

Jefftree avatar Jul 04 '24 15:07 Jefftree

Markdown blockquotes look like:

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

sftim avatar Jul 04 '24 16:07 sftim

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.

Jefftree avatar Jul 04 '24 16:07 Jefftree

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Oct 02 '24 17:10 k8s-triage-robot

@jefftree I'm happy to see this land. I can review it but you'd need to either explain how to test this, or give me an explain-it-like-I-use-Go-more-than-once-every-5-years guide to setting up a local dev environment (yes those overlap a bit).

sftim avatar Oct 20 '24 12:10 sftim

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Nov 19 '24 12:11 k8s-triage-robot

/remove-lifecycle rotten

It looks like https://github.com/kubernetes-sigs/reference-docs/pull/365 has fixed things a bit such that they're not all rendered on the same line: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/

I think to test this we'll need a k/k PR showing the updated OpenAPI, and a website PR to show how the updated consumed OpenAPI will resolve the issue which I'll work on opening and linking.

Jefftree avatar Nov 19 '24 17:11 Jefftree

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Feb 17 '25 17:02 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Mar 19 '25 17:03 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-triage-robot avatar Apr 18 '25 18:04 k8s-triage-robot

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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 avatar Apr 18 '25 18:04 k8s-ci-robot