diff --git a/README.md b/README.md index 68bbdc6b55..3e2373d763 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,12 @@ If you have [go] and [docker] installed `go get sigs.k8s.io/kind && kind create 2x speed `kind create cluster` demo kind consists of: - - Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc. - - A command line interface ([`kind`][kind cli]) built on these packages. - - Docker [image(s)][images] written to run systemd, Kubernetes, etc. - - [`kubetest`][kubetest] integration also built on these packages (WIP) +- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc. +- A command line interface ([`kind`][kind cli]) built on these packages. +- Docker [image(s)][images] written to run systemd, Kubernetes, etc. +- [`kubetest`][kubetest] integration also built on these packages (WIP) -kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc]. +kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc]. **NOTE**: kind is still a work in progress, see [docs/roadmap.md]. @@ -61,12 +61,12 @@ See also: the Kubernetes [community page]. ## Why kind? - - kind supports multi-node (including HA) clusters - - kind supports building Kubernetes release builds from source - - support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds. - - kind is written in go, and can be used as a library, has stable releases - - kind supports Windows in addition to MacOS and Linux - - kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind) +- kind supports multi-node (including HA) clusters +- kind supports building Kubernetes release builds from source + - support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds. +- kind is written in go, and can be used as a library, has stable releases +- kind supports Windows in addition to MacOS and Linux +- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind) ## Alternatives @@ -98,9 +98,8 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of [images]: ./images [kubetest]: https://github.com/kubernetes/test-infra/tree/master/kubetest [kubeadm]: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/ -[design doc]: ./docs/design/ -[user guide]: ./docs/user/ -[the docs]: ./docs +[design doc]: https://kind.sigs.k8s.io/docs/design/initial +[user guide]: https://kind.sigs.k8s.io/docs/user/quick-start [SIG-Testing Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-testing [issue tracker]: https://github.com/kubernetes-sigs/kind/issues [filing an issue]: https://github.com/kubernetes-sigs/kind/issues/new diff --git a/images/base/README.md b/images/base/README.md index c0209ab5c5..eb18ca91d7 100644 --- a/images/base/README.md +++ b/images/base/README.md @@ -18,4 +18,4 @@ See also [`pkg/cluster`](./../../pkg/cluster) for logic that interacts with this ## Design -See [docs/base-image.md](./../../docs/design/base-image.md) for more design details. +See [base-image](https://kind.sigs.k8s.io/docs/design/base-image/) for more design details. diff --git a/images/node/README.md b/images/node/README.md index 5624437c12..c4d8dc1f49 100644 --- a/images/node/README.md +++ b/images/node/README.md @@ -9,7 +9,7 @@ Roughly this image is [the base image](./../base), with the addition of: - placing the Kubernetes docker images in `/kind/images/*.tar` - placing a file in `/kind/version` containing the Kubernetes semver -See [`docs/node-image`][docs/node-image.md] for more design details. +See [`node-image`][node-image.md] for more design details. [pkg/build/node_image.go]: ./../../pkg/build/node/node.go -[docs/node-image.md]: ./../../docs/design/node-image.md +[node-image.md]: https://kind.sigs.k8s.io/docs/design/node-image diff --git a/site/content/_index.md b/site/content/_index.md index 9c689798b0..1d37d78d3c 100644 --- a/site/content/_index.md +++ b/site/content/_index.md @@ -9,12 +9,12 @@ If you have [go] and [docker] installed `go get sigs.k8s.io/kind && kind create kind consists of: - - Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc. - - A command line interface ([`kind`][kind cli]) built on these packages. - - Docker [image(s)][images] written to run systemd, Kubernetes, etc. - - [`kubetest`][kubetest] integration also built on these packages (WIP) +- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc. +- A command line interface ([`kind`][kind cli]) built on these packages. +- Docker [image(s)][images] written to run systemd, Kubernetes, etc. +- [`kubetest`][kubetest] integration also built on these packages (WIP) -kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc]. +kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc]. **NOTE**: kind is still a work in progress, see the [roadmap]. @@ -59,12 +59,12 @@ See also: the Kubernetes [community page]. ## Why kind? - - kind supports multi-node (including HA) clusters - - kind supports building Kubernetes release builds from source - - support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds. - - kind is written in go, and can be used as a library, has stable releases - - kind supports Windows in addition to MacOS and Linux - - kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind) +- kind supports multi-node (including HA) clusters +- kind supports building Kubernetes release builds from source + - support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds. +- kind is written in go, and can be used as a library, has stable releases +- kind supports Windows in addition to MacOS and Linux +- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind) ## Alternatives @@ -98,7 +98,7 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of [kubetest]: https://github.com/kubernetes/test-infra/tree/master/kubetest [kubeadm]: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/ [design doc]: ./docs/design/initial -[user guide]: ./docs/user/ +[user guide]: ./docs/user/quick-start [the docs]: ./docs [SIG-Testing Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-testing [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 [roadmap]: ./docs/roadmap [install docker]: https://docs.docker.com/install/ [@BenTheElder]: https://github.com/BenTheElder -[@munnerz]: https://github.com/munnerz \ No newline at end of file +[@munnerz]: https://github.com/munnerz