niclashedam / niclashedam/ebpf-kill-example
docs: Extend documentation
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- C
- Stars
- 24
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
We need a few more documentation entries in the docs folder.
I think these would make good sense:
-
What is eBPF? -
How are eBPF programs loaded?Should describe the loading and attachment functions used in this project. -
Architecture of eBPFShould describe how tracepoints work and how to find information about specific tracepoints. -
LimitationsShould describe the limitations of eBPF programs.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the docs folder by reviewing the existing “What is eBPF?” entry and the project’s kill-tracepoint example. Research the loading and attachment functions, tracepoints and their discovery, and eBPF limitations. Done means the three unchecked topics have clear documentation entries covering the requested material.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100