diff --git a/docs/contributors/principles.md b/docs/contributors/principles.md index f740678d6b..a2fa60022a 100644 --- a/docs/contributors/principles.md +++ b/docs/contributors/principles.md @@ -22,4 +22,4 @@ Here are some specific minikube features that align with our goal: ## Non-Goals * Simplifying Kubernetes production deployment experience -* Supporting all possible deployment configurations of Kubernetes like various types of storage, networking, etc. +* Supporting all possible deployment configurations of Kubernetes, such as storage, networking, etc. diff --git a/site/content/en/docs/Contributing/addons.en.md b/site/content/en/docs/Contributing/addons.en.md index f35b0bd07b..150482fd3c 100644 --- a/site/content/en/docs/Contributing/addons.en.md +++ b/site/content/en/docs/Contributing/addons.en.md @@ -13,7 +13,7 @@ To add a new addon to minikube the following steps are required: * For the new addon's .yaml file(s): * Put the required .yaml files for the addon in the `minikube/deploy/addons` directory. * Add the `kubernetes.io/minikube-addons: ` label to each piece of the addon (ReplicationController, Service, etc.) - * Also, `addonmanager.kubernetes.io/mode` annotation is needed so that your resources are picked up by the `addon-manager` minikube addon. + * Also, the `addonmanager.kubernetes.io/mode` annotation is needed so that your resources are picked up by the `addon-manager`. * In order to have `minikube addons open ` work properly, the `kubernetes.io/minikube-addons-endpoint: ` label must be added to the appropriate endpoint service (what the user would want to open/interact with). This service must be of type NodePort. * To add the addon into minikube commands/VM: diff --git a/site/content/en/docs/Contributing/drivers.en.md b/site/content/en/docs/Contributing/drivers.en.md index c7cae2fde6..954c373874 100644 --- a/site/content/en/docs/Contributing/drivers.en.md +++ b/site/content/en/docs/Contributing/drivers.en.md @@ -8,7 +8,7 @@ description: > This document is written for contributors who are familiar with minikube, who would like to add support for a new VM driver. -minikube relies on docker-machine drivers to manage machines. This document discusses how to modify minikube, so that this driver may be used by `minikube create --vm-driver=`. +minikube relies on docker-machine drivers to manage machines. This document discusses how to modify minikube, so that this driver may be used by `minikube start --vm-driver=`. ## Creating a new driver @@ -96,7 +96,7 @@ func createVMwareFusionHost(config cfg.MachineConfig) interface{} { } ``` -- In init function, register a `DriverDef` in registry. Specify the metadata in the `DriverDef`. As mentioned +- Within the `init()` function, register a `DriverDef` in registry. Specify the metadata in the `DriverDef`. As mentioned earlier, it's builtin, so you also need to specify `DriverCreator` to tell minikube how to create a `drivers.Driver`. - Another important thing is `vmwarefusion` only runs on MacOS. You need to add a build tag on top so it only runs on MacOS, so that the releases on Windows and Linux won't have this driver in registry. diff --git a/site/content/en/docs/Contributing/guide.md b/site/content/en/docs/Contributing/guide.md deleted file mode 100644 index d0356d9682..0000000000 --- a/site/content/en/docs/Contributing/guide.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "Contributor Guide" -date: 2019-07-31 -weight: 1 -description: > - How to become a minikube contributor ---- - -### Code of Conduct - - Be excellent to each another. Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md). - -### License Agreement - -We'd love to accept your patches! Before we can take them, [please fill out either the individual or corporate Contributor License Agreement (CLA)](http://git.k8s.io/community/CLA.md) - -### Finding issues to work on - -* ["good first issue"](https://github.com/kubernetes/minikube/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues where there is a clear path to resolution -* ["help wanted"](https://github.com/kubernetes/minikube/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+) - any issue where we've identified a need, but not the resources to work on it. -* High impact issues are labelled as *priority/important-soon* or *priority/important-longterm* -* Ask on the #minikube Slack if you aren't sure - -Once you've discovered an issue to work on: - -* add a comment mentioning that you plan to work on the issue -* send a PR out that mentions the issue -* Once there is a PR, comment on the issue with `/assign` to assign it to yourself - -### Contributing A Patch - -1. Submit an issue describing your proposed change -2. A reviewer will respond to your issue promptly. -3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above). -4. Fork the minikube repo, develop and test your code changes. -5. Submit a pull request. - -### Style Guides - -For coding, refer to the [Kubernetes Coding Conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md#code-conventions) - -For documentation, refer to the [Kubernetes Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/) diff --git a/site/content/en/docs/Contributing/releasing.en.md b/site/content/en/docs/Contributing/releasing.en.md index d2f8fcb709..90e498f321 100644 --- a/site/content/en/docs/Contributing/releasing.en.md +++ b/site/content/en/docs/Contributing/releasing.en.md @@ -18,7 +18,7 @@ To check, run `git log -- deploy/iso` from the root directory and see if there h Note: you can build the ISO using the `hack/jenkins/build_iso.sh` script locally. -* navigate to the minikube ISO jenkins job +* Navigate to the minikube ISO jenkins job * Ensure that you are logged in (top right) * Click "▶️ Build with Parameters" (left) * For `ISO_VERSION`, type in the intended release version (same as the minikube binary's version) @@ -68,7 +68,7 @@ sh hack/tag_release.sh 1.. This step uses the git tag to publish new binaries to GCS and create a github release: -* navigate to the minikube "Release" jenkins job +* Navigate to the minikube "Release" jenkins job * Ensure that you are logged in (top right) * Click "▶️ Build with Parameters" (left) * `VERSION_MAJOR`, `VERSION_MINOR`, and `VERSION_BUILD` should reflect the values in your Makefile @@ -77,7 +77,7 @@ This step uses the git tag to publish new binaries to GCS and create a github re ## Check the release logs -After job completion, click "Console Output" to verify that the release completed without errors. This is typically where one will see brew automation fail, for instance. +After job completion, click "Console Output" to verify that the release completed without errors. This is typically where one will see brew automation fail, for instance. ## Check releases.json @@ -98,7 +98,7 @@ WARNING: The Brew cask automation is error-prone. please ensure that a PR was cr ## Verification -Verify release checksums by running`make check-release` +Verify release checksums by running `make check-release` ## Update docs diff --git a/site/content/en/docs/Examples/_index.md b/site/content/en/docs/Examples/_index.md index 2c89306d37..6798cc43c9 100755 --- a/site/content/en/docs/Examples/_index.md +++ b/site/content/en/docs/Examples/_index.md @@ -12,7 +12,7 @@ Start a cluster by running: `minikube start` -Access Kubernetes Dashboard within Minikube: +Access the Kubernetes Dashboard running within the minikube cluster: `minikube dashboard` diff --git a/site/content/en/docs/Getting started/_post_install.md b/site/content/en/docs/Getting started/_post_install.md index df614dedd5..77c44f6f94 100644 --- a/site/content/en/docs/Getting started/_post_install.md +++ b/site/content/en/docs/Getting started/_post_install.md @@ -8,7 +8,8 @@ Once started, you can use any regular Kubernetes command to interact with your m ### Increasing memory allocation -minikube only allocates a 2GB of RAM to Kubernetes, which is only enough for basic deployments. If you run into stability issues, increase this value if your system has the resources available. You will need to recreate the VM using `minikube delete` for this to take effect. +minikube only allocates 2GB of RAM by default, which is only enough for trivial deployments. For larger +deployments, increase the memory allocation using the `--memory` flag, or make the setting persistent using: ```shell minikube config set memory 4096 diff --git a/site/content/en/docs/Getting started/_virtualbox.md b/site/content/en/docs/Getting started/_virtualbox.md index e985597595..9f2c51c55f 100644 --- a/site/content/en/docs/Getting started/_virtualbox.md +++ b/site/content/en/docs/Getting started/_virtualbox.md @@ -1,6 +1,6 @@ -Dwnload and install the latest version of VirtualBox from https://www.virtualbox.org/ +Download and install the latest version of VirtualBox from https://www.virtualbox.org/ -Once installed, you can start minikube without any special flags: +Once installed, start minikube: ```shell minikube start diff --git a/site/content/en/docs/Getting started/linux.md b/site/content/en/docs/Getting started/linux.md index 27dccb3a15..4b7dddfe5b 100644 --- a/site/content/en/docs/Getting started/linux.md +++ b/site/content/en/docs/Getting started/linux.md @@ -2,8 +2,6 @@ title: "Linux" linkTitle: "Linux" weight: 1 -description: > - How to install and start minikube on Linux. --- ## Installation @@ -90,8 +88,7 @@ If you see any errors, stop now and consult your distributions documentation on ```shell minikube start --vm-driver=kvm2 ``` - -To make the kvm2 driver to be the default for future minikube invocations, run: +To make kvm2 the default for future invocations, run: ```shell minikube config set vm-driver kvm2 diff --git a/site/content/en/docs/Getting started/macos.md b/site/content/en/docs/Getting started/macos.md index 7f75b8c319..938b63e7c9 100644 --- a/site/content/en/docs/Getting started/macos.md +++ b/site/content/en/docs/Getting started/macos.md @@ -2,8 +2,6 @@ title: "macOS" linkTitle: "macOS" weight: 2 -description: > - How to install and start minikube on macOS. --- ### Prerequisites @@ -70,8 +68,7 @@ docker-machine-driver-hyperkit \ minikube start --vm-driver=hyperkit ``` - -To make the hyperkit driver to be the default for future minikube invocations, run: +To make hyperkit the default for future invocations: ```shell minikube config set vm-driver hyperkit @@ -87,7 +84,7 @@ Start minikube with Parallels support using: minikube start --vm-driver=parallels ``` -To make the parallels driver to be the default for future minikube invocations, run: +To make parallels the default for future invocations: ```shell minikube config set vm-driver parallels @@ -96,16 +93,16 @@ minikube config set vm-driver parallels {{% tab "VMware Fusion" %}} -Start minikube with VMware support using: +Start minikube with VMware Fusion support using: ```shell -minikube start --vm-driver=vmware +minikube start --vm-driver=vmwarefusion ``` -To make the vmware driver to be the default for future minikube invocations, run: +To make vmwarefusion the default for future invocations: ```shell -minikube config set vm-driver vmware +minikube config set vm-driver vmwarefusion ``` {{% /tab %}} diff --git a/site/content/en/docs/Getting started/windows.md b/site/content/en/docs/Getting started/windows.md index cd430e22c7..e01a6662e5 100644 --- a/site/content/en/docs/Getting started/windows.md +++ b/site/content/en/docs/Getting started/windows.md @@ -2,8 +2,6 @@ title: "Windows" linkTitle: "Windows" weight: 3 -description: > - How to install and start minikube on Windows. --- ### Prerequisites @@ -57,7 +55,6 @@ Hyper-V Requirements: A hypervisor has been detected. ``` {{% tabs %}} - {{% tab "VirtualBox" %}} {{% readfile file="/docs/Getting started/_virtualbox.md" %}} {{% /tab %}} @@ -69,16 +66,15 @@ If Hyper-V is active, you can start minikube with Hyper-V support using: minikube start --vm-driver=hyperv ``` -NOTE: If this doesn't work, you may need to create an external switch. +NOTE: If this fails due to networking issues, see the [Hyper-V driver documentation](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyper-v-driver) for further instructions. -To make the hyperv driver to be the default for future minikube invocations, run: +To make hyperv the default for future invocations: ```shell minikube config set vm-driver hyperv ``` {{% /tab %}} - {{% /tabs %}} {{% readfile file="/docs/Getting started/_post_install.md" %}} \ No newline at end of file diff --git a/site/content/en/docs/Tasks/addons.md b/site/content/en/docs/Tasks/addons.md index 2e401cc459..037dfbb3ce 100644 --- a/site/content/en/docs/Tasks/addons.md +++ b/site/content/en/docs/Tasks/addons.md @@ -6,7 +6,7 @@ description: > Using addons --- -minikube has a set of built in addons that can be used enabled within Kubernetes. +minikube has a set of built-in addons that, when enabled, can be used within Kubernetes. ## Available addons