Docs don't seem to be generated anywhere.

[pdougall1]

You've got this huge API but I can't find any docs about it.

While spelunking I found a lot of beautiful documentation (really great work IMO) and it looks like you're using swagger, but I don't see the docs generated anywhere.

I'm actually fine just grepping through the code but I wanted to bring it to your attention in case someone finds this great library while in a more frustrated state and dismisses it too early to find out how extensive it is.

Also, it is entirely likely the docs are generated somewhere and I just missed them. In that case please excuse me and help me know where they are.

Thanks again for the great tool!

[itowlson]

I think at the moment there are just the JSDoc comments - I don't think they are rendered to HTML or pushed to a site. I suspect the assumption is that people will refer to the k8s API documentation for what all the objects and operations mean, but I can see how it would be difficult for a new user to locate the appropriate operations or types within the JS library.

@brendandburns is there a k8s site for official client documentation?

[brendandburns]

Not that I know of, but I filed an intern proposal recently for someone to create such a thing :)

[brendandburns]

The general API reference is here:

https://kubernetes.io/docs/reference/

But that's language agnostic.

[burn2delete]

This library is built with swagger, so you can use Swagger UI or any of those tools.

To view API docs: https://petstore.swagger.io
Change JSON file at the top to: https://raw.githubusercontent.com/kubernetes-client/javascript/master/node-client/src/swagger.json

[alewitt]

fyi: Change JSON file at the top to: https://raw.githubusercontent.com/kubernetes-client/javascript/master/src/swagger.json

[kevinsimper]

It would be nice with some published documentation for the function kc.loadFromDefault();, but I can just read the sourcecode, but for beginners 😄

[NathanRSmith]

It would be wonderful if there was some description of the naming scheme in the README. I understand that it's generated from Swagger, but until the JSDocs are hosted somewhere, even a description of how to roughly translate from the k8s API Docs to the code API would be helpful.

I'm not opposed to spelunking, but attempting to use this lib while still getting up to speed on the k8s API itself was a bit frustrating. The lib is functional, but not quite user-friendly yet imo. Good start though.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[kevinsimper]

/remove-lifecycle rotten

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale