Merge pull request #45503 from verb/doc-staging-copy

Automatic merge from submit-queue Update instructions for client staging copy Following the existing instructions results in: ``` % ./staging/copy.sh Do not run this script directly, but via hack/update-staging-client-go.sh. ``` Also format README.md as markdown. **What this PR does / why we need it**: Updates docs to match reality **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: **Special notes for your reviewer**: **Release note**: ```release-note NONE ```

Merge pull request #45503 from verb/doc-staging-copy
cd3ad561 · Kubernetes Submit Queue · GitHub · 1e6061b9 · 01c6f898 · cd3ad561
Commit cd3ad561 authored May 16, 2017 by Kubernetes Submit Queue Committed by GitHub May 16, 2017
Hide whitespace changes
Inline Side-by-side

Showing with 16 additions and 3 deletions

README.md staging/README.md +16 -3

No files found.
--- a/staging/README.md
+++ b/staging/README.md
-This staging/src/k8s.io/client-go directory is the staging area of the client repo. It contains a versioned client, tools built around the client like the reflector, and all the client dependencies. The content will be periodically published to k8s.io/client-go repo.
+This directory is the staging area for packages that have been split to their
-The staged content is copied from the main repo, i.e., k8s.io/kubernetes, with directory rearrangement and necessary rewritings. To sync the content with the latest code in your local k8s.io/kubernetes, you need to run `godep restore` in k8s root directory, then run staging/copy.sh.
+own repository. The content here will be periodically published to respective
-vendor/k8s.io/client-go is a symlink pointing to this staging area, so to use the packages in the staging area, you can import it as "vendor/client-go/<package-name>", as if the client were vendored. The client will be vendored from k8s.io/client-go for real after the test matrix is converted to vendor k8s components.
+top-level k8s.io repositories.
+Most code in the `staging/` directory is authoritative, i.e. the only copy of
+the code. You can directly modify such code. However the packages in
+`staging/src/k8s.io/client-go/pkg` are copied from `pkg/`. If you modify the
+original code in `pkg/`, you need to run `hack/godep-restore.sh` from the k8s
+root directory, followed by `hack/update-staging-client-go.sh`. We are working
+towards making all code in `staging/` authoritative.
+The `vendor/k8s.io` directory contains symlinks pointing to this staging area,
+so to use a package in the staging area, you can import it as
+`k8s.io/<package-name>`, as if the package were vendored. Packages will be
+vendored from `k8s.io/<package-name>` for real after the test matrix is
+converted to vendor k8s components.