From c81b4d637ff7d65aa6d07c15287efc57ce18d594 Mon Sep 17 00:00:00 2001 From: rxinui Date: Thu, 20 Nov 2025 19:58:29 +0100 Subject: [PATCH 1/2] nit: fixes on kyaml reference Signed-off-by: rxinui --- content/en/docs/reference/_index.md | 5 +++++ content/en/docs/reference/encodings/_index.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 59b0eeeeb11cb..f1e94c44d2a49 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -115,3 +115,8 @@ An archive of the design docs for Kubernetes functionality. Good starting points [Kubernetes Architecture](https://git.k8s.io/design-proposals-archive/architecture/architecture.md) and [Kubernetes Design Overview](https://git.k8s.io/design-proposals-archive). +## Encodings + +These are encodings defined by the Kubernetes project + +* [KYAML](/docs/reference/encodings/kyaml) \ No newline at end of file diff --git a/content/en/docs/reference/encodings/_index.md b/content/en/docs/reference/encodings/_index.md index 5cbad9647a21b..cfe248756e04f 100644 --- a/content/en/docs/reference/encodings/_index.md +++ b/content/en/docs/reference/encodings/_index.md @@ -6,6 +6,6 @@ no_list: true card: name: encodings title: Kubernetes encodings - weight: 20 + weight: 125 --- From 5bdbbaa6f803313fc40aa66e489c1a39cf27242f Mon Sep 17 00:00:00 2001 From: rxinui Date: Fri, 21 Nov 2025 11:42:26 +0100 Subject: [PATCH 2/2] Update content/en/docs/reference/_index.md Co-authored-by: Tim Bannister <193443691+lmktfy@users.noreply.github.com> --- content/en/docs/reference/_index.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index f1e94c44d2a49..7bf29f2dfb956 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -117,6 +117,17 @@ An archive of the design docs for Kubernetes functionality. Good starting points ## Encodings -These are encodings defined by the Kubernetes project +Tools such as {{< glossary_tooltip text="kubectl" term_id="kubectl" >}} +can work with different formats / encodings. These include: -* [KYAML](/docs/reference/encodings/kyaml) \ No newline at end of file +* [CBOR](https://cbor.io/), used on the network but **not** available as a kubectl output format + * See [CBOR resource encoding](https://kubernetes.io/docs/reference/using-api/api-concepts/#cbor-encoding) +* [JSON](https://www.json.org/), available as a `kubectl` output format and also used at the HTTP layer +* [KYAML](/docs/reference/encodings/kyaml), a Kubernetes dialect of YAML + * KYAML is essentially an _output format_; any place where you can provide KYAML to Kubernetes, you can also provide any other valid YAML input +* [YAML](https://yaml.org/), available as a `kubectl` output format and also used at the HTTP layer + +Kubernetes also has a custom [protobuf encoding](/docs/reference/using-api/api-concepts/#protobuf-encoding) that is only used within HTTP messages. + +The `kubectl` tool supports some other output formats, such as _custom columns_; +see [output formats](/docs/reference/kubectl/#output-options) in the kubectl reference. \ No newline at end of file