Docs updates (kube-burner#395)

Making the contributing section clearer, fixes broken link
and some other minor improvements to readability.

Fixes: kube-burner#392

Signed-off-by: Sai Sindhur Malleni <[email protected]>
Co-authored-by: Raúl Sevilla <[email protected]>

README.md

@@ -6,14 +6,14 @@
 
 # What is Kube-burner
 
-Kube-burner is a Kubernetes performance toolset. It provides multiple functionalities where the most hightliged can be summarized in:
+Kube-burner is a Kubernetes performance and scale test orchestration framework. It provides multi-faceted functionality, the most important of which are summarized below.
 
-- Create, delete and patch Kubernetes at scale.
+- Create, delete and patch Kubernetes resources at scale.
 - Prometheus metric collection and indexing.
 - Measurements.
 - Alerting.
 
-Kube-burner is a binary application written in golang that makes an intensive usage of the official k8s client library, [client-go](https://github.com/kubernetes/client-go).
+Kube-burner is a binary application written in golang that makes extensive usage of the official k8s client library, [client-go](https://github.com/kubernetes/client-go).
 
 ![Demo](docs/media/demo.gif)
 
@@ -31,6 +31,6 @@ In case you want to start tinkering with Kube-burner now:
 
 ## Contributing Guidelines, CI, and Code Style
 
-Please read the [Development section](https://cloud-bulldozer.github.io/kube-burner/development/) before contributing to this project. It provides information on how to contribute, guidelines for setting an environment a CI checks to be done before commiting code.
+Please read the [Contributing section](https://cloud-bulldozer.github.io/kube-burner/latest/contributing/) before contributing to this project. It provides information on how to contribute, guidelines for setting an environment a CI checks to be done before commiting code.
 
 This project utilizes a Continuous Integration (CI) pipeline to ensure code quality and maintain project standards. The CI process automatically builds, tests, and verifies the project on each commit and pull request.

docs/contributing/index.md

@@ -0,0 +1,35 @@
+# Contributing to kube-burner
+
+If you want to contribute to kube-burner, you can do so by submitting a Pull Request, Issue or starting a Discussion.
+
+## Making changes and opening a Pull Request
+
+For submitting a change upstream, please fork the repository and clone your forked repository.
+```bash
+$ git clone http://github.com/YOUR-USERNAME/kube-burner
+$ cd kube-burner
+$ git checkout -b <branch_name>
+$ <make change>
+$ git add <changes>
+$ git commit -a
+$ <insert good message>
+$ git push
+```
+
+## CI and Linting
+
+For running pre-commit checks on your code before comitting code and opening a PR, you can use the `pre-commit run` functionality.  See [CI docs](https://cloud-bulldozer.github.io/kube-burner/latest/contributing/ci) for more information.
+
+## Building
+
+To build kube-burner just execute `make build`, once finished the kube-burner binary should be available at `./bin/<arch>/kube-burner`.
+
+!!! Note
+    Building kube-burner requires `golang >=1.19`
+
+```console
+$ make build
+building kube-burner 0.1.0
+GOPATH=/home/kube-burner/go
+CGO_ENABLED=0 go build -v -ldflags "-X github.com/cloud-bulldozer/kube-burner/version.GitCommit=d91c8cc35cb458a4b80a5050704a51c7c6e35076 -X github.com/cloud-bulldozer/kube-burner/version.BuildDate=2020-08-19-19:10:09 -X github.com/cloud-bulldozer/kube-burner/version.GitBranch=master" -o bin/kube-burner
+```

mkdocs.yml

@@ -12,11 +12,11 @@ nav:
   - Indexing: observability/indexing.md
   - Alerting: observability/alerting.md
 - OpenShift Wrapper: ocp.md
-- Development:
-  - development/index.md
-  - Development: development/index.md
-  - CI: development/ci.md
-  - Tests: development/ci/tests.md
+- Contributing:
+  - contributing/index.md
+  - Contributing: contributing/index.md
+  - CI: contributing/ci.md
+  - Tests: contributing/ci/tests.md
 site_name: Kube-burner
 plugins:
   - search