During the initial usage of the new SDK k8s{CRUD}Resource calls I noticed there was some gaps in the documentation for these methods. There is also lack of docs for the hook utilities around fetching resources. So we need to close that gap so users can make effective use of our SDK offerings.

Acceptance Criteria

• Issues with current documentation in k8s-resource.ts:
  • k8sGet, K8sCreate, k8sUpdate, k8sPatch, k8sKill, k8sList
    • We should flag these all as deprecated for exposed API. We want them to migrate to the k8s[CRUD]Resource calls
  • k8sUpdateResource
    • 'name' & 'ns' are not identified in the docs except they are needed to make the call
  • k8sListResource
    • Doesn't specify 'raw' prop despite being in the dep list
  • k8sKill
    • There is a typo in the list of props 'options.' prefix is on 'json'
• Issues with current documentation in console-fetch.ts:
  • consoleFetchText, consoleFetch
    • Specifies 'method' in the docs despite manually configures it with a constant string
• Issue with useK8sModel param (they don't align)
• Lacking current documentation:
  • useK8sWatchResource
  • useK8sWatchResources
• Expose useK8sWatchResource(s) functions in the index

Questions

• We didn't export useK8sWatchResource(s) functions in the index? Is this a bug or are they not exposed? (this impacts the two notes in the AC – if they are not exposed then we do not need to document them) Discussed with Jai, we want them exposed