bpftime icon indicating copy to clipboard operation
bpftime copied to clipboard

[FEATURE] Enhance documents

Open yunwei37 opened this issue 1 year ago • 7 comments

Is your feature request related to a problem? Please describe.

We need more documents:

  • [ ] Description of how to use bpftime for uprobe, syscall tracing
  • [ ] The details of how bpftime works

Describe the solution you'd like

Add documents in eunomia.dev

Describe alternatives you've considered

Provide usage examples

Additional context

yunwei37 avatar Nov 19 '23 23:11 yunwei37

Hey @yunwei37, I would like to contribute to this issue as my first contribution in your org. So, can you please assign it to me to get the work done? Thanks.

Viveksati5143 avatar Feb 25 '24 13:02 Viveksati5143

Thanks!

yunwei37 avatar Feb 25 '24 14:02 yunwei37

The documents have been moved to https://github.com/eunomia-bpf/eunomia.dev/blob/main/docs/bpftime

So please update the documents there

yunwei37 avatar Feb 25 '24 14:02 yunwei37

Maybe you can first update the documents for bpftimetool?

https://github.com/eunomia-bpf/bpftime/tree/master/tools/bpftimetool

You can create a new markdown file in the eunomia.dev repo, and updated the https://github.com/eunomia-bpf/eunomia.dev/blob/main/mkdocs.yaml for that.

The website will be updated automatically once the PR is merged.

yunwei37 avatar Feb 25 '24 14:02 yunwei37

Sure, looking into it,..

Viveksati5143 avatar Feb 25 '24 14:02 Viveksati5143

Maybe you can first update the documents for bpftimetool?

https://github.com/eunomia-bpf/bpftime/tree/master/tools/bpftimetool

You can create a new markdown file in the eunomia.dev repo, and updated the https://github.com/eunomia-bpf/eunomia.dev/blob/main/mkdocs.yaml for that.

The website will be updated automatically once the PR is merged.

Can you provide what in the documentation should be updated?

Viveksati5143 avatar Feb 25 '24 19:02 Viveksati5143

You can create a new markdown file like https://github.com/eunomia-bpf/eunomia.dev/blob/main/docs/bpftime/documents/co-re.md in https://github.com/eunomia-bpf/eunomia.dev/blob/main/docs/bpftime/documents/, add details about bpftimetool, and update the https://github.com/eunomia-bpf/eunomia.dev/blob/main/mkdocs.yaml for the new doc.

yunwei37 avatar Feb 25 '24 21:02 yunwei37