Update Contributing docs (aquasecurity#4424)

* add first changes to guidelines

* improve docs of guidelines and overview in contributing

* combine documentation and code guidelines

* improve docs for setup development machine

* improve building tracee docs

* improve environment building docs

* change console to bash

* add Kubernetes, Performance and Man docs to tracee

* add checkers docsto guidelines

* fix minor issues

* resolve most changes

* improve metrics=1 docs

* improve guidelines to use makefiles mostly

* update make help

* add help text

* enhance Issues  docs part, added candidate labe docs

* Update docs/contributing/overview.md

Co-authored-by: Gregório G. <[email protected]>

* enhance backported and cherry-picked labels docs

* add candidate label docs

* added backport and cherry-pick labels

* fix nit issues un the docs

- remove "." in building.md
- change "DWARF generation by setting" to "DWARF debug symbols by setting"
- combine docs about `alphine` and `ubuntu`
- make sense of enviornmet help arg
- fix grammer issues
- enhance vargant docs
- added default comment for the dev vagrant vm
- remove 12 and 13 version for clang llvm
- fix dockerfile links

* fix dockerfile path and name

* fix nit issues

remove tracee-gptdocs
remove Alpine linux require to build statisc binary
remove which includes that refare to nothing

---------

Co-authored-by: Gregório G. <[email protected]>

Author: ShohamBit

Makefile

@@ -320,6 +320,7 @@ help:
 	@echo "    $$ STATIC=1 make ...             # build static binaries"
 	@echo "    $$ BTFHUB=1 STATIC=1 make ...    # build static binaries, embed BTF"
 	@echo "    $$ DEBUG=1 make ...              # build binaries with debug symbols"
+	@echo "    $$ METRICS=1 make ...            # build enabling BPF metrics"
 	@echo ""
 
 #

docs/contributing/building/building.md

@@ -12,43 +12,33 @@
 
 2. Building **dependencies**
 
-    1. **clang** && **llvm** (12, 13 or 14)
-    1. **golang** (1.22.3 toolchain)
-    1. **libelf** and **libelf-dev**
+    1. `clang` && `llvm` (14)
+    2. `golang` (1.22.3 toolchain)
+    3. `libelf` and `libelf-dev`
        (or elfutils-libelf and elfutils-libelf-devel)
-    1. **zlib1g** and **zlib1g-dev**
+    4. `zlib1g` and `zlib1g-dev`
        (or zlib and zlib-devel)
-    1. **libzstd-dev** for static build (libelf linkage)
-    1. **clang-format-12** (specific version) for `fix-fmt`
+    5. `libzstd-dev` for static build (libelf linkage)
+    6. `clang-format-12` (specific version) for `fix-fmt`
 
     > You might take a look at the following files to understand how to have a
     > building environment:
     >
     > 1. [.github/actions/build-dependencies/action.yaml](https://github.com/aquasecurity/tracee/blob/main/.github/actions/build-dependencies/action.yaml)
-    > 1. [packaging/Dockerfile.ubuntu-packaging](https://github.com/aquasecurity/tracee/blob/main/packaging/Dockerfile.ubuntu-packaging)
-    > 1. [packaging/Dockerfile.fedora-packaging](https://github.com/aquasecurity/tracee/blob/main/packaging/Dockerfile.fedora-packaging)
+    > 1. [builder/Dockerfile.ubuntu-tracee-make](https://github.com/aquasecurity/tracee/blob/main/builder/Dockerfile.ubuntu-tracee-make)
+    > 1. [builder/Dockerfile.alpine-tracee-make](https://github.com/aquasecurity/tracee/blob/main/builder/Dockerfile.alpine-tracee-make)
     >
     > Those are very good examples for you to replicate a working environment.
 
 3. **Clone** [tracee repository](https://github.com/aquasecurity/tracee/)
 
-    ```console
-    git clone [email protected]:aquasecurity/tracee
-    ```
-
-    ```text
-    Cloning into 'tracee'...
-    remote: Enumerating objects: 13251, done.
-    remote: Counting objects: 100% (555/555), done.
-    remote: Compressing objects: 100% (240/240), done.
-    remote: Total 13251 (delta 343), reused 369 (delta 280), pack-reused 12696
-    Receiving objects: 100% (13251/13251), 11.75 MiB | 8.62 MiB/s, done.
-    Resolving deltas: 100% (8105/8105), done.
+    ```bash
+    git clone [https://github.com/aquasecurity/tracee/](https://github.com/aquasecurity/tracee/)
     ```
 
 4. All makefiles have a **help** target to give you needed instructions
 
-    ```console
+    ```bash
     make help
     ```
 
@@ -68,6 +58,7 @@
         $ make e2e-net-signatures       # build ./dist/e2e-net-signatures
         $ make e2e-inst-signatures      # build ./dist/e2e-inst-signatures
         $ make tracee                   # build ./dist/tracee
+        $ make tracee-operator          # build ./dist/tracee-operator
 
     # clean
 
@@ -78,6 +69,7 @@
         $ make clean-tracee-bench       # wipe ./dist/tracee-bench
         $ make clean-signatures         # wipe ./dist/signatures
         $ make clean-tracee             # wipe ./dist/tracee
+        $ make clean-tracee-operator    # wipe ./dist/tracee-operator
 
     # test
 
@@ -90,65 +82,28 @@
         $ STATIC=1 make ...             # build static binaries
         $ BTFHUB=1 STATIC=1 make ...    # build static binaries, embed BTF
         $ DEBUG=1 make ...              # build binaries with debug symbols
+        $ METRICS=1 make ...            # build enabling BPF metrics
+
     ```
 
 5. Build **all** targets at once
 
-    ```console
+    ```bash
     make all
     ```
 
-    ```text
-    Submodule 'libbpf' (https://github.com/libbpf/libbpf.git) registered for path '3rdparty/libbpf'
-    Cloning into '/home/rafaeldtinoco/tracee/3rdparty/libbpf'...
-    mkdir -p dist/signatures
-    GOOS=linux CC=clang GOARCH=amd64 CGO_CFLAGS= CGO_LDFLAGS= go build \
-        --buildmode=plugin \
-        -o dist/signatures/builtin.so \
-        signatures/golang/export.go signatures/golang/kubernetes_api_connection.go signatures/golang/stdio_over_socket.go
-    ```
-
 6. Build a **static binary** by setting `STATIC=1`
 
-    ```console
+    ```bash
     STATIC=1 make all
     ```
 
-    ```text
-    CC="clang" \
-        CFLAGS=""-fPIC"" \
-        LD_FLAGS="" \
-        make \
-        -C ./3rdparty/libbpf/src \
-        BUILD_STATIC_ONLY=1 \
-        DESTDIR=/home/rafaeldtinoco/tracee/dist/libbpf \
-        OBJDIR=/home/rafaeldtinoco/tracee/dist/libbpf/obj \
-        INCLUDEDIR= LIBDIR= UAPIDIR= prefix= libdir= \
-        install install_uapi_headers
-    ...
-    ```
-
 7. Build a **static binary** with [BTFHUB Support](https://github.com/aquasecurity/btfhub)
 
-    ```console
+    ```bash
     BTFHUB=1 STATIC=1 make all
     ```
 
-    ```text
-    Cloning into '/home/rafaeldtinoco/tracee/3rdparty/btfhub'...
-    remote: Enumerating objects: 205, done.
-    remote: Counting objects: 100% (16/16), done.
-    remote: Compressing objects: 100% (12/12), done.
-    remote: Total 205 (delta 4), reused 10 (delta 3), pack-reused 189
-    Receiving objects: 100% (205/205), 10.59 MiB | 7.56 MiB/s, done.
-    Resolving deltas: 100% (73/73), done.
-    Cloning into '/home/rafaeldtinoco/tracee/3rdparty/btfhub-archive'...
-    remote: Enumerating objects: 1993, done.
-    remote: Counting objects: 100% (28/28), done.
-    remote: Compressing objects: 100% (23/23), done.
-    Receiving objects:  15% (301/1993), 154.97 MiB | 15.72 MiB/s
-    ```
-
     !!! Note
         BTFHUB support will embed several very small files (BTF files) into your
         final binary. Those files will allow **tracee** binary to be executed
@@ -163,19 +118,16 @@
         >plugin.Open("/tracee/dist/signatures/builtin.so"): Dynamic loading not supported
         >```
 
-8. Build a **debugable binary** with DWARF generation by setting `DEBUG=1`
+8. Build a **debuggable binary** with DWARF debug symbols by setting `DEBUG=1`
 
-    ```console
+    ```bash
     DEBUG=1 make
     ```
-    
-    ```text
-    GOOS=linux CC=clang GOARCH=amd64 CGO_CFLAGS="-I/home/gg/code/tracee/dist/libbpf" CGO_LDFLAGS="-lelf  -lz  /home/gg/code/tracee/dist/libbpf/libbpf.a" go build \
-        -tags core,ebpf \
-        -ldflags=" \
-             -extldflags \"\" \
-             -X main.version=\"v0.8.0-107-g121efeb\" \
-            " \
-        -v -o dist/tracee \
-       ./cmd/tracee
+
+9. Build enabling BPF metrics by setting `METRICS=1`
+
+    BPF metrics are only available if the BPF object is built with `METRICS` debug flag defined.
+
+    ```bash
+    METRICS=1 make
     ```