docs: hosts autogenerated docs on GitHub Pages via Actions, updates README

[mattxwang]

Hi! This is a relatively small PR that addresses #697. It does two things:

1. consumes JamesIves/github-deploy-action to push the output of npm run docs to the gh-pages branch, only on push to master
2. updates the README with relevant links and information (badge, hosted docs, and the K8s API reference discussed in the issue)

On top of merging this PR in, we would also need to manually enable pages, which can be done in Settings > Pages > Source > "gh-pages" (with / as the root). That would deploy the site to https://kubernetes-client.github.io/javascript/

You can test my changes in the fork at https://mattxwang.github.io/javascript/

Let me know if there's anything else I should add/remove to this PR!

(as a follow up, I think it might be helpful to include the relevant versions for the docs somewhere on the site; that likely warrants a follow-up PR)

[k8s-ci-robot]

Welcome @mattxwang!

It looks like this is your first PR to kubernetes-client/javascript 🎉. 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-client/javascript 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. 😃

[mattxwang]

/kind documentation

[brendandburns]

/lgtm
/approve

Thanks!

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brendandburns, mattxwang

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 [brendandburns]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[mattxwang]

Thanks @brendandburns! I think there's one more step that we need to do, and I can't do it to this repository without admin privileges:

On top of merging this PR in, we would also need to manually enable pages, which can be done in Settings > Pages > Source > "gh-pages" (with / as the root). That would deploy the site to https://kubernetes-client.github.io/javascript/

If you'd like, we could also add the link to the repository info section.

[brendandburns]

This is now done.

https://kubernetes-client.github.io/javascript/

If there are additional PRs to add links to the README feel free to send them along.

Thanks!

[mattxwang]

Hi @brendandburns, I'm not sure if the GitHub pages host is pointing to the right branch - https://kubernetes-client.github.io/javascript/ looks like it's just hosting the README currently, while https://mattxwang.github.io/javascript/ has the rest of the Typedoc UI (i.e. search bar, classes on the right, etc.) - would you be able to check that GitHub Pages is pointed at gh-pages when you have a chance?