Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Contributing docs #4424

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/contributing/building/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,9 @@
```bash
ShohamBit marked this conversation as resolved.
Show resolved Hide resolved
DEBUG=1 make
```

9. Build with embedded metrics (pprof) by setting `METRICS=1`
ShohamBit marked this conversation as resolved.
Show resolved Hide resolved

```bash
METRICS=1 make
```
2 changes: 1 addition & 1 deletion docs/contributing/building/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
--scope follow
```

Now, in your host's bash shell, execute a command. You will see all events
Now, in your host's shell, execute a command. You will see all events
(except scheduler ones) being printed, in "table format", to stdout.

## How to build and use the environment
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing/setup-development-machine-with-vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ 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:** Use the default setting (no action needed), or explicitly set:
- **Development Environment:** Full development environment

```bash
export VM_TYPE=dev
```

- **Testing Environment:**
- **Testing Environment:** Smaller vagrant machine without k8s cumbersome to avoid conflicts with specific tests.

```bash
export VM_TYPE=test
Expand Down Expand Up @@ -70,7 +70,7 @@ Run the following command to start the VM:
vagrant up
```

Vagrant will download the base box (Ubuntu 22.04), provision the VM, and install all required dependencies. This process may take some time.
Vagrant will download the base box, provision the VM, and install all required dependencies. This process may take some time.

## Accessing the VM

Expand Down
Loading