kpt.dev: Generate a UI for custom resource schema

[droot]

The reference for Kptfile schema can live under reference or under Appendix section. This page will be referenced by other end user docs and CLI command help texts.

Older site had the reference here We can repurpose the tooling here to improve the styling to match current style and evolve it over time.

Some inspiration: Go Releaser I like this presentation because it is a nice mix of example and schema information. Kustomize

[droot]

/cc @frankfarzan

[droot]

A reference page for k8s deployment:

https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#deployment-v1-apps

[frankfarzan]

In terms of where this should live on the site:

• reference/
  • cli
    • pkg
    • fn
    • live
  • schema
    • Kptfile
    • FunctionResults

e.g.:

kpt.dev/reference/cli/pkg/get kpt.dev/reference/schema/kptfile

Please update all existing links.

[frankfarzan]

We have a stop-gap solution where we link directly to Go code for Kptfile and FunctionResultList:

https://kpt.dev/reference/schema/

This issue is tracking the end result:

• Generate the OpenAPI schema for these kinds
• Generates a UI from the schema (Including ResourceList)

For examples, refer to the k8s API reference for core kinds: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/

@droot is the PoC for using kubebuilder to generate the schema from Go types.