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.

Sign up for GitHub

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

Jump to bottom

API spec reference for popular resources? #50

Open

ryanj opened this issue Jun 25, 2020 · 1 comment

Labels

wontfix

Member

ryanj commented Jun 25, 2020

Consider parsing contents from the openAPI spec to generate markdown-based reference materials https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json

Would auto-generated content provide a better UX and improved SEO (compared to browsing the API using a swagger client)?

ryanj changed the title ~~API references?~~ API spec reference for popular resources?

jboxman commented Jul 29, 2020

@ryanj, I currently do this for the OCP 4.x API reference docs. The output is Asciidoc, however.

https://github.com/jboxman/openshift-apidocs-gen

ryanj added the wontfix label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment