From c1b629f8e3d2389016cdcd6152255d46c712f03e Mon Sep 17 00:00:00 2001 From: Daniel Holbach <daniel@weave.works> Date: Fri, 13 Sep 2019 13:33:44 +0200 Subject: [PATCH] move examples/ guides to docs/ --- README.md | 8 ++++++-- examples/footloose/README.md => docs/wks-and-footloose.md | 0 examples/vagrant/README.md => docs/wks-and-vagrant.md | 0 examples/gce/README.md => docs/wks-on-gce.md | 0 4 files changed, 6 insertions(+), 2 deletions(-) rename examples/footloose/README.md => docs/wks-and-footloose.md (100%) rename examples/vagrant/README.md => docs/wks-and-vagrant.md (100%) rename examples/gce/README.md => docs/wks-on-gce.md (100%) diff --git a/README.md b/README.md index 44ae514..39f0330 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,11 @@ sudo mv wksctl /usr/local/bin/ ## Quick start -The [examples](examples) folder (also included in the release package download) contains guides to get you up and running with [Footloose](https://github.com/weaveworks/footloose), [Vagrant](https://www.vagrantup.com) and others! +We put together a couple of guides to get you up and running with WKS in combination with [Footloose](https://github.com/weaveworks/footloose), [Vagrant](https://www.vagrantup.com) and others! + +- [WKS and Footloose](docs/wks-and-footloose.md) - this includes the Firekube approach (WKS+Footloose+Ignite) +- [WKS and Vagrant](docs/wks-and-vagrant.md) +- [WKS on GCE](docs/wks-on-gce.md) ## Modes of use @@ -71,7 +75,7 @@ Other interesting resources include: - [The issue tracker](https://github.com/weaveworks/wksctl/issues) - [Developing `wksctl`](docs/development.md) -## Documentation +## More Documentation - [Frequently asked questions](docs/faq.md) - [Developing `wksctl`](docs/development.md) diff --git a/examples/footloose/README.md b/docs/wks-and-footloose.md similarity index 100% rename from examples/footloose/README.md rename to docs/wks-and-footloose.md diff --git a/examples/vagrant/README.md b/docs/wks-and-vagrant.md similarity index 100% rename from examples/vagrant/README.md rename to docs/wks-and-vagrant.md diff --git a/examples/gce/README.md b/docs/wks-on-gce.md similarity index 100% rename from examples/gce/README.md rename to docs/wks-on-gce.md -- GitLab