Merge pull request #44 from henry-jackson/spelling-fixes

docs: fix spelling & grammar in docs
profefe · Oct 30, 2020 · b581b10 · b581b10
2 parents 0b643ed + 07c2e56
commit b581b10
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/docs/content/docs/developing.md b/docs/content/docs/developing.md
@@ -4,7 +4,8 @@ description = "Contributing to kube-profefe"
 weight = 30
 draft = false
 toc = true
-bref = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur neque risus, maximus malesuada massa eget, auctor vulputate ipsum. Suspendisse magna libero, iaculis non ante nec, laoreet faucibus ligula. Suspendisse sed enim urna. Quisque libero dui, porttitor eu diam quis, elementum mattis nunc."
+bref = "An overview of the kube-profefe delivery and testing toolchain for
+contributors"
 +++
 
 This project is written in Go and it uses [go
@@ -53,7 +54,7 @@ have to spin up a temporary kubernetes cluster for my test. It requires Docker.
 $ kind create cluster
 ```
 
-I can run locally `kprofefe` to see how it works but it won't be able to
+I can run `kprofefe` locally to see how it works but it won't be able to
 actually scrape profiles because it tries to reach the pprof endpoint using POD
 IPs, and they are not reachable from my local laptop.
 

diff --git a/docs/content/docs/getting-started.md b/docs/content/docs/getting-started.md
@@ -55,7 +55,7 @@ Apply this spec via `kubectl apply -f <path file.yaml>`. It will create a
 profefe namespace, and it will deploy the
 [profefe](https://github.com/profefe/profefe) as a deployment with its service.
 
-This installation it's not for production.
+This installation is not for production.
 
 ```yaml
 apiVersion: v1

diff --git a/docs/content/docs/introduciton.md b/docs/content/docs/introduciton.md
@@ -12,8 +12,8 @@ bref = ""
 This project is a bridge between profefe and Kubernetes. At the moment it serves
 two different binaries:
 
-* `kubectl-profefe` a kubectl plugin that helps you to `caputre` pprof profiles,
-  storing them locally or in pprofefe. It uses `port-forwarding` to expose the
+* `kubectl-profefe` a kubectl plugin that helps you to `capture` pprof profiles,
+  storing them locally or in profefe. It uses `port-forwarding` to expose the
   pprof port locally.
 * `kprofefe` is a cli that you can run as a cronjob in your kubernetes cluster.
   It discovers running pods in your clusters, it downloads profiles and it