Description
Hi! First of all, really appreciate this library, I'm already finding it very useful - and appreciate the work that goes into this.
I know there's been some discussion already around hosted docs (a quick search gives me #618, #594, #485, #133, #128, #15), and the general response is that they're not that useful/it would make more sense to refer to the API Reference or the code examples, which are both reasonable requests.
However, I think it still might be useful to have a copy floating around - as a developer using the library, it's a bit easier for me to read the generated docs rather than to just use the GitHub search bar. And, for other users with similar use-cases, they won't have to clone + npm install & npm run docs to peek at the documentation.
With that in mind, is it possible to deploy a copy of the docs somewhere online? I know that we likely want as minimal load + to keep them as up to date as possible, so I'm thinking something like:
- write a GitHub Action that auto-runs
npm run docson push tomaster, and deploys it to a static host of our choice (ex GitHub Pages, Netlify, etc.) - note somewhere on the generated site and in the README:
- the API reference and code examples make good documentation
- the current docs are not particularly great, and community contribution is always helpful
- the current live version of the docs
I'm more than happy to take up some of this work!
Very open to suggestions of course, and I'm still new to the Kubernetes ecosystem in general, so more perspective is great!