-
Notifications
You must be signed in to change notification settings - Fork 424
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
base: main
Are you sure you want to change the base?
Update Contributing docs #4424
Conversation
…ntributing_docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First pass.
First pass Need to update the result of
The difference:
|
-v -o dist/tracee \ | ||
./cmd/tracee | ||
|
||
9. Build enabling BPF metrics by setting `METRICS=1`. |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some considerations:
- maybe would be good to add the help output;
- I think we should add some instructions do setup the cluster or point to a link with those instructions;
- Please check the
manifests
andgenerate
, it seems to not be working (maybe we need to open an issue).
There was a problem hiding this comment.
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?
…ntributing_docs
1. Explain what the PR does
This PR is about #4406
"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