Update reference-docs repo (#16622)

reference-docs moved from kubernetes-incubator to kubernetes-sigs

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
This commit is contained in:
aimeeu
2019-09-30 14:42:46 -05:00
committed by Kubernetes Prow Robot
parent d223df1f69
commit bd7308274e
4 changed files with 20 additions and 20 deletions
@@ -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/pflag
go get -u github.com/spf13/cobra go get -u github.com/spf13/cobra
go get -u gopkg.in/yaml.v2 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: If you don't already have the kubernetes/website repository, get it now:
@@ -101,9 +101,9 @@ base directory is `$GOPATH/src/github.com/<your-username>/website.`
The remaining steps refer to your base directory as `<web-base>`. The remaining steps refer to your base directory as `<web-base>`.
* Determine the base directory of your clone of the * 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 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 `<rdocs-base>`. The remaining steps refer to your base directory as `<rdocs-base>`.
In your local k8s.io/kubernetes repository, check out the branch of interest, 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 ## 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: kubectl command reference generation code. You might need to run the command as root:
```shell ```shell
@@ -8,7 +8,7 @@ content_template: templates/task
This page shows how to update the generated reference docs for the Kubernetes API. This page shows how to update the generated reference docs for the Kubernetes API.
The Kubernetes API reference documentation is built from the The Kubernetes API reference documentation is built from the
[Kubernetes OpenAPI spec](https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json) [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 If you find bugs in the generated documentation, you need to
[fix them upstream](/docs/contribute/generate-ref-docs/contribute-upstream/). [fix them upstream](/docs/contribute/generate-ref-docs/contribute-upstream/).
@@ -50,7 +50,7 @@ export GOPATH=$HOME/<workspace>
Get a local clone of the following repositories: Get a local clone of the following repositories:
```shell ```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/loads
go get -u github.com/go-openapi/spec go get -u github.com/go-openapi/spec
@@ -79,8 +79,8 @@ The remaining steps refer to your base directory as `<k8s-base>`.
The remaining steps refer to your base directory as `<web-base>`. The remaining steps refer to your base directory as `<web-base>`.
* The base directory of your clone of the * The base directory of your clone of the
[kubernetes-incubator/reference-docs](https://github.com/kubernetes-incubator/reference-docs) [kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs)
repository is `$GOPATH/src/github.com/kubernetes-incubator/reference-docs.` repository is `$GOPATH/src/github.com/kubernetes-sigs/reference-docs.`
The remaining steps refer to your base directory as `<rdocs-base>`. The remaining steps refer to your base directory as `<rdocs-base>`.
@@ -80,7 +80,7 @@ directory. The tool performs the following steps:
1. Clones the related repositories specified in a configuration file. For the 1. Clones the related repositories specified in a configuration file. For the
purpose of generating reference docs, the repository that is cloned by 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 1. Runs commands under the cloned repositories to prepare the docs generator and
then generates the Markdown files. then generates the Markdown files.
1. Copies the generated Markdown files to a local clone of the `kubernetes/website` 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 ```yaml
repos: repos:
- name: reference-docs - 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 # This and the generate-command below needs a change when reference-docs has
# branches properly defined # branches properly defined
branch: master branch: master
@@ -113,8 +113,8 @@ repos:
cp -L -R vendor $GOPATH/src cp -L -R vendor $GOPATH/src
rm -r vendor rm -r vendor
cd $GOPATH cd $GOPATH
go get -v github.com/kubernetes-incubator/reference-docs/gen-compdocs go get -v github.com/kubernetes-sigs/reference-docs/gen-compdocs
cd src/github.com/kubernetes-incubator/reference-docs/ cd src/github.com/kubernetes-sigs/reference-docs/
make comp make comp
``` ```
@@ -126,7 +126,7 @@ For example:
```yaml ```yaml
repos: repos:
- name: reference-docs - name: reference-docs
remote: https://github.com/kubernetes-incubator/reference-docs.git remote: https://github.com/kubernetes-sigs/reference-docs.git
files: files:
- src: gen-compdocs/build/kube-apiserver.md - src: gen-compdocs/build/kube-apiserver.md
dst: content/en/docs/reference/command-line-tools-reference/kube-apiserver.md dst: content/en/docs/reference/command-line-tools-reference/kube-apiserver.md
+3 -3
View File
@@ -1,6 +1,6 @@
repos: repos:
- name: reference-docs - 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 # This and the generate-command below needs a change when reference-docs has
# branches properly defined # branches properly defined
branch: master branch: master
@@ -13,8 +13,8 @@ repos:
cp -L -R vendor $GOPATH/src cp -L -R vendor $GOPATH/src
rm -r vendor rm -r vendor
cd $GOPATH cd $GOPATH
go get -v github.com/kubernetes-incubator/reference-docs/gen-compdocs go get -v github.com/kubernetes-sigs/reference-docs/gen-compdocs
cd src/github.com/kubernetes-incubator/reference-docs/ cd src/github.com/kubernetes-sigs/reference-docs/
make comp make comp
files: files: