From b63067e28702454c5f3848758ae529f0b3a9cfb8 Mon Sep 17 00:00:00 2001 From: Scott Murray Date: Wed, 17 Aug 2022 21:15:17 +1200 Subject: [PATCH] amend docs with project goal --- README.md | 8 +++++--- docs/index.md | 8 +++++++- templates/index.md.tmpl | 8 +++++++- 3 files changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b7628d1..1a195be 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,12 @@ -*CURRENTLY IN PROGRESS* - A terraform provider for [minikube!](https://minikube.sigs.k8s.io/docs/) +The goal of this project is to allow developers to create minikube clusters and integrate it with common kubernetes terraform providers such as [hashicorp/kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/2.12.1) and [hashicorp/helm](https://registry.terraform.io/providers/hashicorp/helm/2.6.0) all within the comfort of Minikube! + +You can learn more about how to use the provider at https://registry.terraform.io/providers/scott-the-programmer/minikube/latest/docs + ## Installing your preferred driver If you don't have minikube installed, or have never run minikube before, you'll need to install your corresponding driver first @@ -25,7 +27,7 @@ minikube --driver=docker --download-only You can find the drivers published in the [minikube releases section](https://github.com/kubernetes/minikube/releases). Simply download the preferred driver and copy it to your .minikube/bin folder and ensure the current user has sufficient access -### Living dangerously +### Living dangerously (discouraged) ```bash #x86_64 diff --git a/docs/index.md b/docs/index.md index ad4792e..a97c59a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,8 @@ description: |- A terraform provider for [minikube!](https://minikube.sigs.k8s.io/docs/) +The goal of this project is to allow developers to create minikube clusters and integrate it with common kubernetes terraform providers such as [hashicorp/kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/2.12.1) and [hashicorp/helm](https://registry.terraform.io/providers/hashicorp/helm/2.6.0) all within the comfort of Minikube! + ## Installing your preferred driver If you don't have minikube installed, or have never run minikube before, you'll need to install your corresponding driver first @@ -26,7 +28,11 @@ minikube --driver=docker --download-only You can find the drivers published in the [minikube releases section](https://github.com/kubernetes/minikube/releases). Simply download the preferred driver and copy it to your .minikube/bin folder and ensure the current user has sufficient access -### Living dangerously +### Automatic Install (discouraged) + +You can invoke a simple bootstrap script called [install-driver.sh](https://github.com/scott-the-programmer/terraform-provider-minikube/blob/main/bootstrap/install-driver.sh) + +Please review the script contents running ```bash #x86_64 diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 29b788c..97dd199 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -8,6 +8,8 @@ description: |- A terraform provider for [minikube!](https://minikube.sigs.k8s.io/docs/) +The goal of this project is to allow developers to create minikube clusters and integrate it with common kubernetes terraform providers such as [hashicorp/kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/2.12.1) and [hashicorp/helm](https://registry.terraform.io/providers/hashicorp/helm/2.6.0) all within the comfort of Minikube! + ## Installing your preferred driver If you don't have minikube installed, or have never run minikube before, you'll need to install your corresponding driver first @@ -26,7 +28,11 @@ minikube --driver=docker --download-only You can find the drivers published in the [minikube releases section](https://github.com/kubernetes/minikube/releases). Simply download the preferred driver and copy it to your .minikube/bin folder and ensure the current user has sufficient access -### Living dangerously +### Automatic Install (discouraged) + +You can invoke a simple bootstrap script called [install-driver.sh](https://github.com/scott-the-programmer/terraform-provider-minikube/blob/main/bootstrap/install-driver.sh) + +Please review the script contents running ```bash #x86_64