Skip to content

Commit c622a73

Browse files
doc: fix paths.
Signed-off-by: Jintao Zhang <[email protected]>
1 parent 54ff8b1 commit c622a73

File tree

4 files changed

+29
-30
lines changed

4 files changed

+29
-30
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ If you have [go] and [docker] installed `go get sigs.k8s.io/kind && kind create
1414
<img src="https://gist.githubusercontent.com/BenTheElder/621bc321fc6d9506fd936feb36d32dd0/raw/7fe14e9d0929cab428929ca6c501abc990c07359/kind-create-cluster.gif" alt="2x speed `kind create cluster` demo" />
1515

1616
kind consists of:
17-
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
18-
- A command line interface ([`kind`][kind cli]) built on these packages.
19-
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
20-
- [`kubetest`][kubetest] integration also built on these packages (WIP)
17+
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
18+
- A command line interface ([`kind`][kind cli]) built on these packages.
19+
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
20+
- [`kubetest`][kubetest] integration also built on these packages (WIP)
2121

22-
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
22+
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
2323

2424
**NOTE**: kind is still a work in progress, see [docs/roadmap.md].
2525

@@ -61,12 +61,12 @@ See also: the Kubernetes [community page].
6161

6262
## Why kind?
6363

64-
- kind supports multi-node (including HA) clusters
65-
- kind supports building Kubernetes release builds from source
66-
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
67-
- kind is written in go, and can be used as a library, has stable releases
68-
- kind supports Windows in addition to MacOS and Linux
69-
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
64+
- kind supports multi-node (including HA) clusters
65+
- kind supports building Kubernetes release builds from source
66+
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
67+
- kind is written in go, and can be used as a library, has stable releases
68+
- kind supports Windows in addition to MacOS and Linux
69+
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
7070

7171
## Alternatives
7272

@@ -98,9 +98,8 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
9898
[images]: ./images
9999
[kubetest]: https://github.com/kubernetes/test-infra/tree/master/kubetest
100100
[kubeadm]: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/
101-
[design doc]: ./docs/design/
102-
[user guide]: ./docs/user/
103-
[the docs]: ./docs
101+
[design doc]: https://kind.sigs.k8s.io/docs/design/initial
102+
[user guide]: https://kind.sigs.k8s.io/docs/user/quick-start
104103
[SIG-Testing Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-testing
105104
[issue tracker]: https://github.com/kubernetes-sigs/kind/issues
106105
[filing an issue]: https://github.com/kubernetes-sigs/kind/issues/new

images/base/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ See also [`pkg/cluster`](./../../pkg/cluster) for logic that interacts with this
1818

1919
## Design
2020

21-
See [docs/base-image.md](./../../docs/design/base-image.md) for more design details.
21+
See [base-image](https://kind.sigs.k8s.io/docs/design/base-image/) for more design details.

images/node/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Roughly this image is [the base image](./../base), with the addition of:
99
- placing the Kubernetes docker images in `/kind/images/*.tar`
1010
- placing a file in `/kind/version` containing the Kubernetes semver
1111

12-
See [`docs/node-image`][docs/node-image.md] for more design details.
12+
See [`node-image`][node-image.md] for more design details.
1313

1414
[pkg/build/node_image.go]: ./../../pkg/build/node/node.go
15-
[docs/node-image.md]: ./../../docs/design/node-image.md
15+
[node-image.md]: https://kind.sigs.k8s.io/docs/design/node-image

site/content/_index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ If you have [go] and [docker] installed `go get sigs.k8s.io/kind && kind create
99

1010
kind consists of:
1111

12-
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
13-
- A command line interface ([`kind`][kind cli]) built on these packages.
14-
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
15-
- [`kubetest`][kubetest] integration also built on these packages (WIP)
12+
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
13+
- A command line interface ([`kind`][kind cli]) built on these packages.
14+
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
15+
- [`kubetest`][kubetest] integration also built on these packages (WIP)
1616

17-
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
17+
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
1818

1919
**NOTE**: kind is still a work in progress, see the [roadmap].
2020

@@ -59,12 +59,12 @@ See also: the Kubernetes [community page].
5959

6060
## Why kind?
6161

62-
- kind supports multi-node (including HA) clusters
63-
- kind supports building Kubernetes release builds from source
64-
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
65-
- kind is written in go, and can be used as a library, has stable releases
66-
- kind supports Windows in addition to MacOS and Linux
67-
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
62+
- kind supports multi-node (including HA) clusters
63+
- kind supports building Kubernetes release builds from source
64+
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
65+
- kind is written in go, and can be used as a library, has stable releases
66+
- kind supports Windows in addition to MacOS and Linux
67+
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
6868

6969
## Alternatives
7070

@@ -98,7 +98,7 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
9898
[kubetest]: https://github.com/kubernetes/test-infra/tree/master/kubetest
9999
[kubeadm]: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/
100100
[design doc]: ./docs/design/initial
101-
[user guide]: ./docs/user/
101+
[user guide]: ./docs/user/quick-start
102102
[the docs]: ./docs
103103
[SIG-Testing Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-testing
104104
[issue tracker]: https://github.com/kubernetes-sigs/kind/issues
@@ -108,4 +108,4 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
108108
[roadmap]: ./docs/roadmap
109109
[install docker]: https://docs.docker.com/install/
110110
[@BenTheElder]: https://github.com/BenTheElder
111-
[@munnerz]: https://github.com/munnerz
111+
[@munnerz]: https://github.com/munnerz

0 commit comments

Comments
 (0)