From bd7308274ecec25648ef73f0a41cffe2bf832cb4 Mon Sep 17 00:00:00 2001 From: aimeeu Date: Mon, 30 Sep 2019 14:42:46 -0500 Subject: [PATCH] Update reference-docs repo (#16622) reference-docs moved from kubernetes-incubator to kubernetes-sigs Signed-off-by: Aimee Ukasick --- .../en/docs/contribute/generate-ref-docs/kubectl.md | 10 +++++----- .../contribute/generate-ref-docs/kubernetes-api.md | 12 ++++++------ .../generate-ref-docs/kubernetes-components.md | 10 +++++----- update-imported-docs/reference.yml | 8 ++++---- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/content/en/docs/contribute/generate-ref-docs/kubectl.md b/content/en/docs/contribute/generate-ref-docs/kubectl.md index 2194e9930885e..dafe7571c761b 100644 --- a/content/en/docs/contribute/generate-ref-docs/kubectl.md +++ b/content/en/docs/contribute/generate-ref-docs/kubectl.md @@ -64,7 +64,7 @@ Get a local clone of the following repositories: go get -u github.com/spf13/pflag go get -u github.com/spf13/cobra go get -u gopkg.in/yaml.v2 -go get -u kubernetes-incubator/reference-docs +go get -u kubernetes-sigs/reference-docs ``` If you don't already have the kubernetes/website repository, get it now: @@ -101,9 +101,9 @@ base directory is `$GOPATH/src/github.com//website.` The remaining steps refer to your base directory as ``. * Determine the base directory of your clone of the -[kubernetes-incubator/reference-docs](https://github.com/kubernetes-incubator/reference-docs) repository. +[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) repository. For example, if you followed the preceding step to get the repository, your -base directory is `$GOPATH/src/github.com/kubernetes-incubator/reference-docs.` +base directory is `$GOPATH/src/github.com/kubernetes-sigs/reference-docs.` The remaining steps refer to your base directory as ``. In your local k8s.io/kubernetes repository, check out the branch of interest, @@ -201,7 +201,7 @@ git pull https://github.com/kubernetes/kubernetes release-1.15 ## Running the doc generation code -In your local kubernetes-incubator/reference-docs repository, build and run the +In your local kubernetes-sigs/reference-docs repository, build and run the kubectl command reference generation code. You might need to run the command as root: ```shell @@ -284,4 +284,4 @@ topics will be visible in the * [Generating Reference Documentation for the Kubernetes API](/docs/home/contribute/generated-reference/kubernetes-api/) * [Generating Reference Documentation for the Kubernetes Federation API](/docs/home/contribute/generated-reference/federation-api/) -{{% /capture %}} \ No newline at end of file +{{% /capture %}} diff --git a/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md b/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md index 4eff9594af7e2..f64156e2c5fa8 100644 --- a/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md +++ b/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md @@ -8,7 +8,7 @@ content_template: templates/task This page shows how to update the generated reference docs for the Kubernetes API. The Kubernetes API reference documentation is built from the [Kubernetes OpenAPI spec](https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json) -and tools from [kubernetes-incubator/reference-docs](https://github.com/kubernetes-incubator/reference-docs). +and tools from [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs). If you find bugs in the generated documentation, you need to [fix them upstream](/docs/contribute/generate-ref-docs/contribute-upstream/). @@ -50,7 +50,7 @@ export GOPATH=$HOME/ Get a local clone of the following repositories: ```shell -go get -u github.com/kubernetes-incubator/reference-docs +go get -u github.com/kubernetes-sigs/reference-docs go get -u github.com/go-openapi/loads go get -u github.com/go-openapi/spec @@ -79,8 +79,8 @@ The remaining steps refer to your base directory as ``. The remaining steps refer to your base directory as ``. * The base directory of your clone of the -[kubernetes-incubator/reference-docs](https://github.com/kubernetes-incubator/reference-docs) -repository is `$GOPATH/src/github.com/kubernetes-incubator/reference-docs.` +[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs) +repository is `$GOPATH/src/github.com/kubernetes-sigs/reference-docs.` The remaining steps refer to your base directory as ``. @@ -183,7 +183,7 @@ static/docs/reference/generated/kubernetes-api/v1.15/scroll.js ## Updating the API reference index pages -* Open `/content/en/docs/reference/kubernetes-api/index.md` for editing, and update the API reference +* Open `/content/en/docs/reference/kubernetes-api/index.md` for editing, and update the API reference version number. For example: ``` @@ -227,4 +227,4 @@ to monitor your pull request until it has been merged. * [Generating Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/) * [Generating Reference Documentation for the Kubernetes Federation API](/docs/home/contribute/generated-reference/federation-api/) -{{% /capture %}} \ No newline at end of file +{{% /capture %}} diff --git a/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md b/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md index d66b510e5914a..a1d2ceab06458 100644 --- a/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md +++ b/content/en/docs/contribute/generate-ref-docs/kubernetes-components.md @@ -80,7 +80,7 @@ directory. The tool performs the following steps: 1. Clones the related repositories specified in a configuration file. For the purpose of generating reference docs, the repository that is cloned by - default is `kubernetes-incubator/reference-docs`. + default is `kubernetes-sigs/reference-docs`. 1. Runs commands under the cloned repositories to prepare the docs generator and then generates the Markdown files. 1. Copies the generated Markdown files to a local clone of the `kubernetes/website` @@ -100,7 +100,7 @@ what it is doing and need to change the specified release branch. ```yaml repos: - name: reference-docs - remote: https://github.com/kubernetes-incubator/reference-docs.git + remote: https://github.com/kubernetes-sigs/reference-docs.git # This and the generate-command below needs a change when reference-docs has # branches properly defined branch: master @@ -113,8 +113,8 @@ repos: cp -L -R vendor $GOPATH/src rm -r vendor cd $GOPATH - go get -v github.com/kubernetes-incubator/reference-docs/gen-compdocs - cd src/github.com/kubernetes-incubator/reference-docs/ + go get -v github.com/kubernetes-sigs/reference-docs/gen-compdocs + cd src/github.com/kubernetes-sigs/reference-docs/ make comp ``` @@ -126,7 +126,7 @@ For example: ```yaml repos: - name: reference-docs - remote: https://github.com/kubernetes-incubator/reference-docs.git + remote: https://github.com/kubernetes-sigs/reference-docs.git files: - src: gen-compdocs/build/kube-apiserver.md dst: content/en/docs/reference/command-line-tools-reference/kube-apiserver.md diff --git a/update-imported-docs/reference.yml b/update-imported-docs/reference.yml index 8e8702f350142..4f9430ca550f8 100644 --- a/update-imported-docs/reference.yml +++ b/update-imported-docs/reference.yml @@ -1,9 +1,9 @@ repos: - name: reference-docs - remote: https://github.com/kubernetes-incubator/reference-docs.git + remote: https://github.com/kubernetes-sigs/reference-docs.git # This and the generate-command below needs a change when reference-docs has # branches properly defined - branch: master + branch: master generate-command: | cd $GOPATH git clone https://github.com/kubernetes/kubernetes.git src/k8s.io/kubernetes @@ -13,8 +13,8 @@ repos: cp -L -R vendor $GOPATH/src rm -r vendor cd $GOPATH - go get -v github.com/kubernetes-incubator/reference-docs/gen-compdocs - cd src/github.com/kubernetes-incubator/reference-docs/ + go get -v github.com/kubernetes-sigs/reference-docs/gen-compdocs + cd src/github.com/kubernetes-sigs/reference-docs/ make comp files: