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

API spec reference for popular resources? #50

Open
ryanj opened this issue Jun 25, 2020 · 1 comment
Open

API spec reference for popular resources? #50

ryanj opened this issue Jun 25, 2020 · 1 comment
Labels

Comments

@ryanj
Copy link
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 ryanj changed the title API references? API spec reference for popular resources? Jun 25, 2020
@jboxman
Copy link

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 ryanj added the wontfix label Apr 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants