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 16 commits into
base: main
Choose a base branch
from

Conversation

ShohamBit
Copy link
Collaborator

1. Explain what the PR does

This PR is about #4406

  • remove and add the documentation to the guidelines
  • add sections on how to contribute to tracee source code
  • improve docs on how to build tracee
  • improve docs on how to build environment

"Replace me with make check-pr output"

2. Explain how to test it

Read the docs and check if its properly align with tracee design

3. Other comments

Close #4406

Copy link
Member

@geyslan geyslan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First pass.

docs/contributing/building/building.md Show resolved Hide resolved
docs/contributing/building/building.md Show resolved Hide resolved
docs/contributing/building/environment.md Outdated Show resolved Hide resolved
docs/contributing/guidelines.md Outdated Show resolved Hide resolved
@ShohamBit ShohamBit requested a review from geyslan December 16, 2024 15:13
@ShohamBit ShohamBit requested a review from geyslan December 17, 2024 20:59
@rscampos
Copy link
Collaborator

rscampos commented Dec 20, 2024

First pass

Need to update the result of make help


The difference:

  • need to add: make tracee-operator and make clean-tracee-operator
  • need to remove: make test-signatures

-v -o dist/tracee \
./cmd/tracee

9. Build enabling BPF metrics by setting `METRICS=1`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we also add the following line in the make help?

$ METRICS=1 make ... # build enabling BPF metrics

Tracee's Makefile provides convenient targets for setting up MicroK8s:

```bash
make -f builder/Makefile.k8s help
Copy link
Collaborator

@rscampos rscampos Dec 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some considerations:

  1. maybe would be good to add the help output;
  2. I think we should add some instructions do setup the cluster or point to a link with those instructions;
  3. Please check the manifests and generate, it seems to not be working (maybe we need to open an issue).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rscampos, I'm having trouble building Tracee with the Kubernetes Makefile. I tried updating the Go version in the Dockerfile and running make from Ubuntu shell, but I'm still hitting errors. Could you offer some guidance?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs/contributing
3 participants