search

kubernetes-sigs / reference-docs

Tools to build reference documentation for Kubernetes APIs and CLIs.
Apache License 2.0
87 stars 102 forks source link

Improve handling of OpenAPI descriptions #365

Closed robert-cronin closed 1 week ago

robert-cronin commented 3 weeks ago

Details can be found at: https://github.com/kubernetes/website/pull/47089

k8s-ci-robot commented 3 weeks ago

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. :smiley:

sftim commented 3 weeks ago

/retitle Improve handling of OpenAPI descriptions

robert-cronin commented 1 week ago

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

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

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

tengqm commented 1 week ago

/approve

Please resolve the conflicts ...

k8s-ci-robot commented 1 week ago

[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: - ~~[OWNERS](https://github.com/kubernetes-sigs/reference-docs/blob/master/OWNERS)~~ [tengqm] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
tengqm commented 1 week ago

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 commented 1 week ago

/approve

Please resolve the conflicts ...

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

tengqm commented 1 week ago

/lgtm