Skip to content

Commit

Permalink
Update reference-docs repo (#16622)
Browse files Browse the repository at this point in the history
reference-docs moved from kubernetes-incubator to kubernetes-sigs

Signed-off-by: Aimee Ukasick <[email protected]>
  • Loading branch information
aimeeu authored and k8s-ci-robot committed Sep 30, 2019
1 parent d223df1 commit bd73082
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
10 changes: 5 additions & 5 deletions content/en/docs/contribute/generate-ref-docs/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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>`.

* 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 `<rdocs-base>`.

In your local k8s.io/kubernetes repository, check out the branch of interest,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 %}}
{{% /capture %}}
12 changes: 6 additions & 6 deletions content/en/docs/contribute/generate-ref-docs/kubernetes-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down Expand Up @@ -50,7 +50,7 @@ export GOPATH=$HOME/<workspace>
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
Expand Down Expand Up @@ -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 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 `<rdocs-base>`.


Expand Down Expand Up @@ -183,7 +183,7 @@ static/docs/reference/generated/kubernetes-api/v1.15/scroll.js
## Updating the API reference index pages


* Open `<web-base>/content/en/docs/reference/kubernetes-api/index.md` for editing, and update the API reference
* Open `<web-base>/content/en/docs/reference/kubernetes-api/index.md` for editing, and update the API reference
version number. For example:

```
Expand Down Expand Up @@ -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 %}}
{{% /capture %}}
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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
Expand All @@ -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
```
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions update-imported-docs/reference.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down

0 comments on commit bd73082

Please sign in to comment.