Skip to content

Commit 8e6dbf8

Browse files
afbjorklundafbjorklund
committed
Run markdownlint on all the md files in docs
1 parent fbd3da2 commit 8e6dbf8

29 files changed

+212
-183
lines changed

‎.markdownlint.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
22
"no-inline-html": false,
33
"no-trailing-punctuation": false,
4+
"blanks-around-fences": false,
5+
"commands-show-output": false,
46
"ul-style": false,
5-
"line_length": false
7+
"line-length": false
68
}

‎docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Advanced Topics and Tutorials
1+
# Advanced Topics and Tutorials
22

3-
### Cluster Configuration
3+
## Cluster Configuration
44

55
* **Alternative Runtimes** ([alternative_runtimes.md](alternative_runtimes.md)): How to run minikube with rkt as the container runtime
66

‎docs/accessing_etcd.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
## Accessing Host Resources From Inside A Pod
2-
### When you have a VirtualBox driver
1+
# Accessing Host Resources From Inside A Pod
2+
3+
## When you have a VirtualBox driver
4+
35
In order to access host resources from inside a pod, run the following command to determine the host IP you can use:
6+
47
```shell
58
ip addr
69
```

‎docs/addons.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
## Add-ons
1+
# Add-ons
22

33
Minikube has a set of built in addons that can be used enabled, disabled, and opened inside of the local k8s environment. Below is an example of this functionality for the `heapster` addon:
4+
45
```shell
56
$ minikube addons list
67
- registry: disabled
@@ -26,6 +27,7 @@ Waiting, endpoint for service is not ready yet...
2627
Waiting, endpoint for service is not ready yet...
2728
Created new window in existing browser session.
2829
```
30+
2931
The currently supported addons include:
3032

3133
* [Kubernetes Dashboard](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/dashboard)

‎docs/alternative_runtimes.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
### Using rkt container engine
1+
# Alternative runtimes
2+
3+
## Using rkt container engine
24

35
To use [rkt](https://github.com/coreos/rkt) as the container runtime run:
46

57
```shell
68
$ minikube start --container-runtime=rkt
79
```
810

9-
10-
### Using CRI-O
11+
## Using CRI-O
1112

1213
To use [CRI-O](https://github.com/kubernetes-sigs/cri-o) as the container runtime, run:
1314

@@ -27,7 +28,7 @@ $ minikube start --container-runtime=cri-o \
2728
--extra-config=kubelet.image-service-endpoint=unix:///var/run/crio/crio.sock
2829
```
2930

30-
### Using containerd
31+
## Using containerd
3132

3233
To use [containerd](https://github.com/containerd/containerd) as the container runtime, run:
3334

‎docs/cache.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Caching Images
1+
# Caching Images
22

33
Minikube supports caching non-minikube images using the `minikube cache` command. Images can be added to the cache by running `minikube cache add <img>`, and deleted by running `minikube cache delete <img>`.
44

‎docs/configuring_kubernetes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
## Configuring Kubernetes
1+
# Configuring Kubernetes
22

33
Minikube has a "configurator" feature that allows users to configure the Kubernetes components with arbitrary values.
44
To use this feature, you can use the `--extra-config` flag on the `minikube start` command.
55

66
This flag is repeated, so you can pass it several times with several different values to set multiple options.
77

8-
### Kubeadm bootstrapper
8+
## Kubeadm bootstrapper
99

1010
The kubeadm bootstrapper can be configured by the `--extra-config` flag on the `minikube start` command. It takes a string of the form `component.key=value` where `component` is one of the strings
1111

‎docs/contributors/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
## Contributing
1+
# Contributing
22

33
* **New contributors** ([contributors.md](https://github.com/kubernetes/minikube/blob/master/CONTRIBUTING.md)): Process for new contributors, CLA instructions
44

55
* **Roadmap** ([roadmap.md](roadmap.md)): The roadmap for future minikube development
66

77
## New Features and Dependencies
8+
89
* **Adding a dependency** ([adding_a_dependency.md](adding_a_dependency.md)): How to add or update vendored code
910

1011
* **Adding a new addon** ([adding_an_addon.md](adding_an_addon.md)): How to add a new addon to minikube for `minikube addons`
1112

1213
* **Adding a new driver** ([adding_driver.md](adding_driver.md)): How to add a new driver to minikube for `minikube create --vm-driver=<driver>`
1314

1415
## Building and Releasing
16+
1517
* **Build Guide** ([build_guide.md](build_guide.md)): How to build minikube from source
1618

1719
* **ISO Build Guide** ([minikube_iso.md](minikube_iso.md)): How to build and hack on the ISO image that minikube uses

‎docs/contributors/adding_a_dependency.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
#### Adding a New Dependency
1+
# Adding a New Dependency
2+
23
Minikube uses `dep` to manage vendored dependencies.
34

45
See the `dep` [documentation](https://golang.github.io/dep/docs/introduction.html) for installation and usage instructions.

‎docs/contributors/adding_an_addon.md

+24-23
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
#### Adding a New Addon
1+
# Adding a New Addon
2+
23
To add a new addon to minikube the following steps are required:
34

45
* For the new addon's .yaml file(s):
@@ -15,12 +16,12 @@ To add a new addon to minikube the following steps are required:
1516
var settings = []Setting{
1617
...,
1718
// add other addon setting
18-
{
19-
name: "efk",
20-
set: SetBool,
21-
validations: []setFn{IsValidAddon},
22-
callbacks: []setFn{EnableOrDisableAddon},
23-
},
19+
{
20+
name: "efk",
21+
set: SetBool,
22+
validations: []setFn{IsValidAddon},
23+
callbacks: []setFn{EnableOrDisableAddon},
24+
},
2425
}
2526
```
2627

@@ -32,22 +33,22 @@ To add a new addon to minikube the following steps are required:
3233
...,
3334
// add other addon asset
3435
"efk": NewAddon([]*BinDataAsset{
35-
NewBinDataAsset(
36-
"deploy/addons/efk/efk-configmap.yaml",
37-
constants.AddonsPath,
38-
"efk-configmap.yaml",
39-
"0640"),
40-
NewBinDataAsset(
41-
"deploy/addons/efk/efk-rc.yaml",
42-
constants.AddonsPath,
43-
"efk-rc.yaml",
44-
"0640"),
45-
NewBinDataAsset(
46-
"deploy/addons/efk/efk-svc.yaml",
47-
constants.AddonsPath,
48-
"efk-svc.yaml",
49-
"0640"),
50-
}, false, "efk"),
36+
NewBinDataAsset(
37+
"deploy/addons/efk/efk-configmap.yaml",
38+
constants.AddonsPath,
39+
"efk-configmap.yaml",
40+
"0640"),
41+
NewBinDataAsset(
42+
"deploy/addons/efk/efk-rc.yaml",
43+
constants.AddonsPath,
44+
"efk-rc.yaml",
45+
"0640"),
46+
NewBinDataAsset(
47+
"deploy/addons/efk/efk-svc.yaml",
48+
constants.AddonsPath,
49+
"efk-svc.yaml",
50+
"0640"),
51+
}, false, "efk"),
5152
}
5253
```
5354

‎docs/contributors/adding_driver.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Adding new driver (Deprecated)
22

3-
New drivers should be added into https://github.com/machine-drivers
3+
New drivers should be added into <https://github.com/machine-drivers>
44

55
Minikube relies on docker machine drivers to manage machines. This document talks about how to
66
add an existing docker machine driver into minikube registry, so that minikube can use the driver
@@ -26,7 +26,7 @@ Registry is what minikube uses to register all the supported drivers. The driver
2626
their drivers in registry, and minikube runtime will look at the registry to find a driver and use the
2727
driver metadata to determine what workflow to apply while those drivers are being used.
2828

29-
The godoc of registry is available here: https://godoc.org/k8s.io/minikube/pkg/minikube/registry
29+
The godoc of registry is available here: <https://godoc.org/k8s.io/minikube/pkg/minikube/registry>
3030

3131
[DriverDef](https://godoc.org/k8s.io/minikube/pkg/minikube/registry#DriverDef) is the main
3232
struct to define a driver metadata. Essentially, you need to define 4 things at most, which is
@@ -52,33 +52,33 @@ All drivers are located in `k8s.io/minikube/pkg/minikube/drivers`. Take `vmwaref
5252
package vmwarefusion
5353

5454
import (
55-
"github.com/docker/machine/drivers/vmwarefusion"
56-
"github.com/docker/machine/libmachine/drivers"
57-
cfg "k8s.io/minikube/pkg/minikube/config"
58-
"k8s.io/minikube/pkg/minikube/constants"
59-
"k8s.io/minikube/pkg/minikube/registry"
55+
"github.com/docker/machine/drivers/vmwarefusion"
56+
"github.com/docker/machine/libmachine/drivers"
57+
cfg "k8s.io/minikube/pkg/minikube/config"
58+
"k8s.io/minikube/pkg/minikube/constants"
59+
"k8s.io/minikube/pkg/minikube/registry"
6060
)
6161

6262
func init() {
63-
registry.Register(registry.DriverDef{
64-
Name: "vmwarefusion",
65-
Builtin: true,
66-
ConfigCreator: createVMwareFusionHost,
67-
DriverCreator: func() drivers.Driver {
68-
return vmwarefusion.NewDriver("", "")
69-
},
70-
})
63+
registry.Register(registry.DriverDef{
64+
Name: "vmwarefusion",
65+
Builtin: true,
66+
ConfigCreator: createVMwareFusionHost,
67+
DriverCreator: func() drivers.Driver {
68+
return vmwarefusion.NewDriver("", "")
69+
},
70+
})
7171
}
7272

7373
func createVMwareFusionHost(config cfg.MachineConfig) interface{} {
74-
d := vmwarefusion.NewDriver(cfg.GetMachineName(), constants.GetMinipath()).(*vmwarefusion.Driver)
75-
d.Boot2DockerURL = config.Downloader.GetISOFileURI(config.MinikubeISO)
76-
d.Memory = config.Memory
77-
d.CPU = config.CPUs
78-
d.DiskSize = config.DiskSize
79-
d.SSHPort = 22
80-
d.ISO = d.ResolveStorePath("boot2docker.iso")
81-
return d
74+
d := vmwarefusion.NewDriver(cfg.GetMachineName(), constants.GetMinipath()).(*vmwarefusion.Driver)
75+
d.Boot2DockerURL = config.Downloader.GetISOFileURI(config.MinikubeISO)
76+
d.Memory = config.Memory
77+
d.CPU = config.CPUs
78+
d.DiskSize = config.DiskSize
79+
d.SSHPort = 22
80+
d.ISO = d.ResolveStorePath("boot2docker.iso")
81+
return d
8282
}
8383
```
8484

@@ -98,4 +98,3 @@ In summary, the process includes the following steps:
9898
2. Add import in `pkg/minikube/cluster/default_drivers.go`
9999

100100
Any Questions: please ping your friend [@anfernee](https://github.com/anfernee)
101-

‎docs/contributors/build_guide.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
### Build Requirements
1+
# Build Guide
2+
3+
## Build Requirements
4+
25
* A recent Go distribution (>=1.12)
36
* If you're not on Linux, you'll need a Docker installation
47
* minikube requires at least 4GB of RAM to compile, which can be problematic when using docker-machine
58

6-
#### Prerequisites for different GNU/Linux distributions
9+
### Prerequisites for different GNU/Linux distributions
710

8-
##### Fedora
9-
On Fedora you need to install _glibc-static_
11+
#### Fedora
1012

13+
On Fedora you need to install _glibc-static_
1114
```shell
1215
$ sudo dnf install -y glibc-static
1316
```
1417

1518
### Building from Source
16-
Clone minikube into your go path under `$GOPATH/src/k8s.io`
1719

20+
Clone minikube into your go path under `$GOPATH/src/k8s.io`
1821
```shell
1922
$ git clone https://github.com/kubernetes/minikube.git $GOPATH/src/k8s.io/minikube
2023
$ cd $GOPATH/src/k8s.io/minikube
@@ -25,20 +28,23 @@ Note: Make sure that you uninstall any previous versions of minikube before buil
2528
from the source.
2629

2730
### Building from Source in Docker (using Debian stretch image with golang)
31+
2832
Clone minikube:
2933
```shell
3034
$ git clone https://github.com/kubernetes/minikube.git
3135
```
36+
3237
Build (cross compile for linux / OS X and Windows) using make:
3338
```shell
3439
$ cd minikube
3540
$ docker run --rm -v "$PWD":/go/src/k8s.io/minikube -w /go/src/k8s.io/minikube golang:stretch make cross
3641
```
42+
3743
Check "out" directory:
3844
```shell
3945
$ ls out/
40-
docker-machine-driver-hyperkit.d minikube minikube.d test.d
41-
docker-machine-driver-kvm2.d minikube-linux-amd64 storage-provisioner.d
46+
docker-machine-driver-hyperkit.d minikube minikube.d test.d
47+
docker-machine-driver-kvm2.d minikube-linux-amd64 storage-provisioner.d
4248
```
4349

4450
### Run Instructions
@@ -77,11 +83,14 @@ You can run these against minikube by following these steps:
7783
* Run `make quick-release` in the k8s repo.
7884
* Start up a minikube cluster with: `minikube start`.
7985
* Set following two environment variables:
86+
8087
```shell
8188
export KUBECONFIG=$HOME/.kube/config
8289
export KUBERNETES_CONFORMANCE_TEST=y
8390
```
91+
8492
* Run the tests (from the k8s repo):
93+
8594
```shell
8695
go run hack/e2e.go -v --test --test_args="--ginkgo.focus=\[Conformance\]" --check-version-skew=false
8796
```

‎docs/contributors/ci_builds.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
### CI Builds
1+
# CI Builds
22

33
We publish CI builds of minikube, built at every Pull Request. Builds are available at (substitute in the relevant PR number):
4-
- https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-darwin-amd64
5-
- https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-linux-amd64
6-
- https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-windows-amd64.exe
4+
5+
- <https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-darwin-amd64>
6+
- <https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-linux-amd64>
7+
- <https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-windows-amd64.exe>
78

89
We also publish CI builds of minikube-iso, built at every Pull Request that touches deploy/iso/minikube-iso. Builds are available at:
9-
- https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-testing.iso
10+
11+
- <https://storage.googleapis.com/minikube-builds/PR_NUMBER/minikube-testing.iso>

‎docs/contributors/minikube_iso.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
## minikube ISO image
1+
# minikube ISO image
22

33
This includes the configuration for an alternative bootable ISO image meant to be used in conjunction with minikube.
44

55
It includes:
6+
67
- systemd as the init system
78
- rkt
89
- docker
@@ -13,9 +14,10 @@ It includes:
1314
### Requirements
1415

1516
* Linux
17+
1618
```shell
1719
sudo apt-get install build-essential gnupg2 p7zip-full git wget cpio python \
18-
unzip bc gcc-multilib automake libtool locales
20+
unzip bc gcc-multilib automake libtool locales
1921
```
2022

2123
Either import your private key or generate a sign-only key using `gpg2 --gen-key`.
@@ -69,7 +71,6 @@ $ git status
6971

7072
### Saving buildroot/kernel configuration changes
7173

72-
7374
To make any kernel configuration changes and save them, execute:
7475

7576
```shell

‎docs/contributors/principles.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,4 @@ Here are some specific minikube features that align with our goal:
2222
## Non-Goals
2323

2424
* Simplifying Kubernetes production deployment experience
25-
* Supporting all possible deployment configurations of Kubernetes like various types of storage, networking, etc.
26-
25+
* Supporting all possible deployment configurations of Kubernetes like various types of storage, networking, etc.

0 commit comments

Comments
 (0)