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

Merged
merged 29 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
bcc39f7
add first changes to guidelines
ShohamBit Dec 9, 2024
55663e1
improve docs of guidelines and overview in contributing
ShohamBit Dec 10, 2024
95e86cc
combine documentation and code guidelines
ShohamBit Dec 10, 2024
2b29f81
improve docs for setup development machine
ShohamBit Dec 10, 2024
0dbe799
improve building tracee docs
ShohamBit Dec 10, 2024
482c107
improve environment building docs
ShohamBit Dec 11, 2024
4bfe816
change console to bash
ShohamBit Dec 11, 2024
3b78323
add Kubernetes, Performance and Man docs to tracee
ShohamBit Dec 11, 2024
c61ecc5
Merge branch 'main' of https://github.com/aquasecurity/tracee into co…
ShohamBit Dec 11, 2024
363e7b2
add checkers docsto guidelines
ShohamBit Dec 11, 2024
0501e58
fix minor issues
ShohamBit Dec 11, 2024
a6b3995
resolve most changes
ShohamBit Dec 12, 2024
ab51f00
improve metrics=1 docs
ShohamBit Dec 17, 2024
540c8ce
improve guidelines to use makefiles mostly
ShohamBit Dec 17, 2024
c14fbca
update make help
ShohamBit Dec 22, 2024
4aae9c7
add help text
ShohamBit Dec 22, 2024
5b9a520
Merge branch 'main' of https://github.com/aquasecurity/tracee into co…
ShohamBit Dec 24, 2024
fe05d9a
enhance Issues docs part, added candidate labe docs
ShohamBit Jan 7, 2025
8d70805
Update docs/contributing/overview.md
ShohamBit Jan 8, 2025
6153e85
enhance backported and cherry-picked labels docs
ShohamBit Jan 8, 2025
9f72406
add candidate label docs
ShohamBit Jan 8, 2025
f63b97d
Merge branch 'contributing_docs' of https://github.com/ShohamBit/trac…
ShohamBit Jan 8, 2025
1ea57fb
Merge branch 'main' of https://github.com/aquasecurity/tracee into co…
ShohamBit Jan 8, 2025
0a6f8cc
added backport and cherry-pick labels
ShohamBit Jan 8, 2025
95eefb1
fix nit issues un the docs
ShohamBit Jan 14, 2025
091416c
Merge branch 'main' of https://github.com/aquasecurity/tracee into co…
ShohamBit Jan 14, 2025
24248f0
fix dockerfile path and name
ShohamBit Jan 14, 2025
27be435
fix nit issues
ShohamBit Jan 15, 2025
398bece
Merge branch 'main' into contributing_docs
ShohamBit Jan 15, 2025
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
ShohamBit marked this conversation as resolved.
Show resolved Hide resolved
```

- **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