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

Improve handling of OpenAPI descriptions #365

Merged

Conversation

robert-cronin
Copy link
Contributor

@robert-cronin robert-cronin commented Jul 4, 2024

Details can be found at: kubernetes/website#47089

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 4, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @robert-cronin!

It looks like this is your first PR to kubernetes-sigs/reference-docs 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/reference-docs has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 4, 2024
@sftim
Copy link
Contributor

sftim commented Jul 4, 2024

/retitle Improve handling of OpenAPI descriptions

@k8s-ci-robot k8s-ci-robot changed the title Update AddContent function to process code blocks in section descript… Improve handling of OpenAPI descriptions Jul 4, 2024
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 16, 2024
@robert-cronin robert-cronin force-pushed the fix/code-render-issue branch 2 times, most recently from 9b02c31 to 8487ec2 Compare July 16, 2024 11:58
@robert-cronin
Copy link
Contributor Author

Now with the goldmark parser, we've made progress:

Screenshot from 2024-07-16 21-56-26

I believe we will still need kubernetes/kube-openapi#482 in order to have the code render correctly with line breaks.

@tengqm
Copy link
Contributor

tengqm commented Jul 16, 2024

/approve

Please resolve the conflicts ...

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: robert-cronin, tengqm

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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 16, 2024
@tengqm
Copy link
Contributor

tengqm commented Jul 16, 2024

I believe we will still need kubernetes/kube-openapi#482 in order to have the code render correctly with line breaks.

The line breaks are defects in the upstream source code comments. I don't think we need to
adapt the parser to bad comment formats.

@robert-cronin robert-cronin marked this pull request as ready for review July 16, 2024 12:15
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 16, 2024
@robert-cronin
Copy link
Contributor Author

/approve

Please resolve the conflicts ...

Thank you for the approve @tengqm, I've resolved the conflicts and rebased onto master.

@tengqm
Copy link
Contributor

tengqm commented Jul 16, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 16, 2024
@k8s-ci-robot k8s-ci-robot merged commit 3a1a8a7 into kubernetes-sigs:master Jul 16, 2024
2 checks passed
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. lgtm "Looks good to me", indicates that a PR is ready to be merged. 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.

4 participants