reference-docs
reference-docs copied to clipboard
Tools to build reference documentation for Kubernetes APIs and CLIs.
**This is a Bug Report** **Problem:** When I execute the command below in website repo , an error occurs: ``` root@test-vm-luxin:/opt/code/website# make api-reference rm -rf content/en/docs/reference/kubernetes-api/*/ cd api-ref-generator/gen-resourcesdocs && \...
According to - [moving kubeadm out of kubernetes/kubernetes](https://docs.google.com/document/d/1xFAGAjfPQZrcqmapTwpJR5aUA7-2ku1asVeq3dBrjnQ/edit?pli=1#heading=h.58e6aprofbeq) - [KEP 1425](https://github.com/kubernetes/enhancements/pull/1425) we are supposed to use the kubernetes/kubeadm repo as the upstream for reference code generation.
Problem description: visit this page [in-depth-monoliths-detailed-spec.md](https://github.com/kubernetes-sigs/reference-docs/blob/master/content/en/blog/releases/in-depth-monoliths-detailed-spec.md) and this page also [second-post.md](https://github.com/kubernetes-sigs/reference-docs/blob/master/content/en/blog/news/second-post.md) - redundancy of this sentence `There should be white-space between paragraphs` does not find any usefulness. If we really...
Kubernetes Code: https://github.com/kubernetes/kubernetes/blob/26842bb0c8fcf89885798a2ebd9a97cd104e78bf/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go#L37 ```go // ``` // ::= // // (Note that may be empty, from the "" case in .) // // ::= 0 | 1 | ... |...
While the autoscaling/v1 Scale is [included in the docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#scale-v1-autoscaling), the autoscaling/v1 ScaleSpec and autoscaling/v1 ScaleStatus are not. I checked multiple reference versions (1.21, 1.20, 1,19) and this is true for...
When a part of the Kubernetes HTTP API includes a subresource, document the subresources. Related to https://github.com/kubernetes/website/issues/27745 (about `eviction` within `pods`)
The current doc generator is centered around resources and operations on them. There are quite a few other non-resource paths which can/should be processed. Need to: - figure out a...
I stumbled over this yesterday during a train travel: I wanted to look up `kubectl` command line flags on my phone (Google Pixel 2) and found that the reference docs...
Improve component reference generator for kubectl so that the references are generated into sub-directories. This change has no impact on other components like kube-apiserver, kube-controller-manager. It make impact how kubeadm...
It looks like something has broken for the kubectl docs generation scripting. There is currently at least one flag (I need to investigate further to determine if there are more)...