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
aquasecurity · Jan 14, 2025 · 95eefb1 · 95eefb1
1 parent 0a6f8cc
commit 95eefb1
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 25 deletions.
diff --git a/docs/contributing/building/building.md b/docs/contributing/building/building.md
@@ -12,21 +12,21 @@
 
 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. [packaging/Dockerfile.ubuntu-packaging](https://github.com/aquasecurity/tracee/blob/main/builder/Dockerfile.ubuntu-tracee-make)
+    > 1. [packaging/Dockerfile.alpine-packaging](https://github.com/aquasecurity/tracee/blob/main/builder/Dockerfile.alpine-tracee-make)
     >
     > Those are very good examples for you to replicate a working environment.
 
@@ -119,13 +119,13 @@
         >plugin.Open("/tracee/dist/signatures/builtin.so"): Dynamic loading not supported
         >```
 
-8. Build a **debuggable binary** with DWARF generation by setting `DEBUG=1`
+8. Build a **debuggable binary** with DWARF debug symbols by setting `DEBUG=1`
 
     ```bash
     DEBUG=1 make
     ```
 
-9. Build enabling BPF metrics by setting `METRICS=1`.
+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.
 

diff --git a/docs/contributing/building/environment.md b/docs/contributing/building/environment.md
@@ -47,9 +47,8 @@ There are Two different environments that are maintained for building tracee:
 * **Alpine**
 * **Ubuntu**
 
-The reason for that is that **Alpine Linux** is based in the [musl](https://en.wikipedia.org/wiki/Musl) C standard library.
-
-while the **Ubuntu Linux** uses [glibc](https://en.wikipedia.org/wiki/Glibc).
+The reason for that is that `Alpine Linux` is based in the [musl](https://en.wikipedia.org/wiki/Musl) C standard library,
+while the `Ubuntu Linux` uses [glibc](https://en.wikipedia.org/wiki/Glibc).
 
 By supporting both building environments we can always be sure that the project builds (and executes) correctly in both environments.
 
@@ -102,7 +101,7 @@ Instead of executing a builder shell, you may use `alpine-make`, or
         make -f builder/Makefile.tracee-make ubuntu-make ARG="tracee"
         ```
 
-    * Show help for make file:
+    * Show available `ubuntu-make` commands:
 
         ```bash
         make -f builder/Makefile.tracee-make ubuntu-make ARG="help"
@@ -139,7 +138,7 @@ If you don't want to depend on host's libraries versions, or your host is not an
 
 2. Verify the executable is static
 
-    * Note: ldd print the shared libraries required by an executable file
+    * Note: ldd prints the shared libraries required by an executable file
 
     ```bash
     ldd dist/tracee

diff --git a/docs/contributing/guidelines.md b/docs/contributing/guidelines.md
@@ -46,7 +46,7 @@ To contribute to the code:
 
 Tracee relies on several generated files and has strict formatting requirements. Ensure you run the following commands before committing:
 
-**`NOTE:`** In order to not depend on host's libraries versions, We recommend that you always run make and other project dependencies on a virtual environment so the formatting will be align with tracee guidelines
+**`NOTE:`** In order to not depend on host's libraries versions, we recommend that you always run make and other project dependencies on a virtual environment so the formatting will be align with Tracee guidelines
 
 1. Man Pages Generation: If you've modified core code or documentation that impacts the man pages, run:
 
@@ -66,7 +66,7 @@ Tracee relies on several generated files and has strict formatting requirements.
 
 3. Pre-commit checks: Every time you're about to create a pull request, execute:
 
-    **`NOTE:`**  If your host machine dependencies doesn't align with tracee dependencies, This command have to run on a supported [environment](./building/environment.md)
+    **`NOTE:`**  If your host machine dependencies doesn't align with Tracee dependencies, This command have to run on a supported [environment](./building/environment.md)
 
     ```bash
     make check-pr
@@ -108,4 +108,4 @@ To ensure your contributions maintain optimal performance, follow the guidelines
 
 ### Kubernetes Considerations
 
-If your contribution impacts Tracee's behavior within a Kubernetes cluster, follow the guidelines in [Kubernetes Considerations](./kubernetes.md)
+If your contribution impacts Tracee's behavior within a Kubernetes cluster, follow the guidelines in [Kubernetes Considerations](./kubernetes.md).
diff --git a/docs/contributing/overview.md b/docs/contributing/overview.md
@@ -14,7 +14,7 @@ If you have a suggestion, question, or a general comment - please use Discussion
 ## Discussions
 
 - We have the following discussion topics:
-    1. [Announcements](https://github.com/aquasecurity/tracee/discussions/categories/announcements): One way communication from the team to the community. Consider this like our mini blog
+    1. [Announcements](https://github.com/aquasecurity/tracee/discussions/categories/announcements): One way communication from the team to the community. Consider this like our mini blog.
     1. [Questions and Help](https://github.com/aquasecurity/tracee/discussions/categories/questions-and-help): For help and support. Consider this similar to StackOverflow.
     1. [Development](https://github.com/aquasecurity/tracee/discussions/categories/development): For discussing potential features, and collaborating on their design.
 

diff --git a/docs/contributing/performance.md b/docs/contributing/performance.md
@@ -1,18 +1,18 @@
 # Performance Considerations
 
-1. **Profiling with Pyroscope:** Tracee integrates with Pyroscope for continuous profiling. When running Tracee locally for development or testing, use the --pyroscope command-line option. For example:
+1. **Profiling Tracee for Performance test** - Tracee integrates with Pyroscope and Pprof for continuous profiling. When running Tracee locally for development or testing, use the `--pyroscope --pprof` command-line option.
 
     ```bash
-    sudo ./dist/tracee --pyroscope
+    sudo ./dist/tracee --pyroscope --pprof
     ```
 
-    This enables profiling data to be sent to a local Pyroscope server. The Tracee repository includes a convenient way to deploy a performance dashboard for analyzing this data. Run the following for more details:
+    This enables profiling data to be sent to a local server. The Tracee repository includes a convenient way to deploy a performance dashboard for analyzing this data. Run the following for more details:
 
     ```bash
     make -f builder/Makefile.performance help
     ```
 
-2. **Performance Dashboard:** The provided performance dashboard allows visualization of host metrics, CPU flame graphs, and other performance-related data. Follow these steps to deploy locally and see instructions on using the dasboard:
+2. **Performance Dashboard:** The provided performance dashboard allows visualization of host metrics, CPU flame graphs, and other performance-related data. Follow these steps to deploy locally and see instructions on using the dashboard:
 
     ```bash
     make -f builder/Makefile.performance dashboard-start

diff --git a/docs/contributing/setup-development-machine-with-vagrant.md b/docs/contributing/setup-development-machine-with-vagrant.md
@@ -24,7 +24,7 @@ git clone https://github.com/aquasecurity/tracee.git
 
 ## Navigate to the Tracee Directory
 
-Open a terminal and navigate to the directory containing the `Vagrantfile.builder` within the cloned Tracee repository. Rename `Vagrantfile.builder` to `Vagrantfile`.
+Open a terminal and navigate to the directory containing the `Vagrantfile` within the cloned Tracee repository (`tracee/`)
 
 ```bash
 cd tracee
@@ -34,7 +34,7 @@ cd tracee
 
 The VM can be provisioned for either a `dev` or `test` environment. The `dev` environment includes additional tools like MicroK8s, kubectl, and Helm.
 
-- **Development Environment:** Full development environment
+- **Development Environment:** Full development environment (Default)
 
   ```bash
   export VM_TYPE=dev