redbpf
redbpf copied to clipboard
foniod
Documentation link broken
"Documentation" link, under "Getting Started". to https://foniod.org/api/cargo_bpf/ is broken.
@rsdy It seems that there are broken links in foniod.org
And it's worth updating some documentations in docs.rs. Rust users normally are looking for some documentation in docs.rs, right?
I found documentation of these crates in docs.rs https://docs.rs/redbpf-macros/2.0.1/redbpf_macros/ https://docs.rs/bpf-sys/2.0.1/bpf_sys/ https://docs.rs/redbpf/2.0.1/redbpf/
But there are missing documentation of crates below cargo-bpf redbpf-probes
Have documentations been updated automatically when the crates are uploaded to crates.io? Or did you update the documentations in person?
Previously we did have some code to automatically bump documentation after a release, that I believe was removed during the move to Github actions. I think it should be easy to resurrect.
I'd like to resurrect the documentation update logic so that we can provide documentation of all crates at docs.rs. I am going to fix this soon. And IMHO it is good to post some technical articles to foniod.org site but docs.rs seems a more suitable place for API reference.
hmm.. it has failed to run cargo rustdoc for cargo-bpf and redbpf-probes crates in docs.rs.
It seems not an easy task to solve this problem... phew..
https://docs.rs/crate/cargo-bpf/2.0.1 https://docs.rs/crate/redbpf-probes/2.0.1
I am going to look into this problem and find a solution or a workaround.
Although neither exhaustive nor the best but I think the documentation in iovisor/bcc is relatively well organized and beginner friendly with plenty of examples.
@ghostpepper108 Thanks for your suggestion. I totally agree with your opinion. As a first step for a better documentation other than API references, I tried to write a beginners tutorial few weeks ago. Have you ever read this tutorial? https://github.com/foniod/redbpf/blob/main/TUTORIAL.md The link of this tutorial is also mentioned at README.md too.
It took much time for me to write this tutorial because of my insufficient English writing skills 😅 If you find some awkward sentences that are grammatically wrong or errors in the information, you could correct them and send a PR 😄 And of course, any contribution to documentation will be welcomed.
Many thanks to your interest to redBPF and I also feel happy to hear from you. I am going to add more documentation to redbpf continuously. However because I am poor at writing in English and I am contributing to redbpf only in my free time, so it will take some time to be equipped with enough documentation if nobody volunteers to do it. But I wish you understand my mind that I hope to accomplish the task. I like to develop redbpf and also I hope to help users achieve their goals with redbpf. I only do this just for fun and for opensource culture. Haha.