c6a0e4f7be
Automatic merge from submit-queue (batch tested with PRs 57380, 57758). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix typo and generate specs, so docs can be regenerated. **What this PR does / why we need it**: This PR is a second attempt at something I tried to do in #57525. I have revised the process according to guidance from @mbohlool. The purpose of this PR is for me to learn the process of updating the [Kubernetes API reference documentation](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.9/), and then to document that process. I'm working on getting the process documented in [PR 6366](https://github.com/kubernetes/website/pull/6366) in the kubernetes/website repository. Here's a [preview of the new topic](https://deploy-preview-6366--kubernetes-io-master-staging.netlify.com/docs/home/contribute/generated-reference/kubernetes-api/). In the docs, I would like to refer to this PR as an example. So I have kept the change simple: fix one typo. Related issues: https://github.com/kubernetes/website/issues/921 https://github.com/kubernetes/website/issues/922 **Special notes for your reviewer**: In the future, we might want to make the doc generation process a bit more automatic. But for now I think it's important to get the current process documented. **Release note**: ```release-note NONE ```
External Repository Staging Area
This directory is the staging area for packages that have been split to their own repository. The content here will be periodically published to respective top-level k8s.io repositories.
Repositories currently staged here:
k8s.io/apiextensions-apiserverk8s.io/apik8s.io/apimachineryk8s.io/apiserverk8s.io/client-gok8s.io/kube-aggregatork8s.io/code-generatork8s.io/metricsk8s.io/sample-apiserverk8s.io/sample-controller
The code in the staging/ directory is authoritative, i.e. the only copy of the code. You can directly modify such code.
Using staged repositories from Kubernetes code
Kubernetes code uses the repositories in this directory via symlinks in the
vendor/k8s.io directory into this staging area. For example, when
Kubernetes code imports a package from the k8s.io/client-go repository, that
import is resolved to staging/src/k8s.io/client-go relative to the project
root:
// pkg/example/some_code.go
package example
import (
"k8s.io/client-go/dynamic" // resolves to staging/src/k8s.io/client-go/dynamic
)
Once the change-over to external repositories is complete, these repositories
will actually be vendored from k8s.io/<package-name>.