Skip to content

Commit

Permalink
docs: call out kele-get's support for custom resources
Browse files Browse the repository at this point in the history
  • Loading branch information
jinnovation committed Jan 15, 2023
1 parent d3627c8 commit 39f303a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
5 changes: 5 additions & 0 deletions docs/how-tos/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ candidates for:
- The namespace (if the resource kind is namespaced), and finally;
- The name of the resource itself.

!!! tip ""

`kele-get` supports [custom resources] too!

??? example "Demo"

![](./img/kele-get.gif)
Expand Down Expand Up @@ -100,3 +104,4 @@ M-x kele-namespace-switch-for-current-context
```

[Embark]: https://github.com/oantolin/embark
[custom resources]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
14 changes: 11 additions & 3 deletions docs/references/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,16 @@ versioning][semver].

## Upcoming

This release introduces `kele-get` -- `kubectl get`, the Emacs way :rocket:. See
[How-Tos > Usage > Working with
This release introduces `kele-get` -- `kubectl get`, the Emacs way
:rocket:. With `kele-get` you can interactively specify the kind and name of the
resource that you'd like to `get` and display its manifest in a separate
buffer. What's more, it supports custom resources right out the gate -- a
[long-standing functionality gap in `kubernetes-el`][k8s-el-69].

See [How-Tos > Usage > Working with
Resources](../how-tos/usage.md#working-with-resources) for details and a demo
GIF.
GIF. It's very much an MVP so there are some rough edges. Please open an [issue]
for any peculiar behavior that you notice.

### Added

Expand Down Expand Up @@ -84,3 +90,5 @@ future enhancements.

[1]: https://github.com/ahmetb/kubectx
[progress report]: https://www.gnu.org/software/emacs/manual/html_node/elisp/Progress.html
[k8s-el-69]: https://github.com/kubernetes-el/kubernetes-el/issues/69
[issue]: https://github.com/kubernetes-el/kubernetes-el/issues

0 comments on commit 39f303a

Please sign in to comment.