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

[FEATURE] Enhance documents #92

Closed
2 tasks
yunwei37 opened this issue Nov 19, 2023 · 7 comments
Closed
2 tasks

[FEATURE] Enhance documents #92

yunwei37 opened this issue Nov 19, 2023 · 7 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@yunwei37
Copy link
Member

yunwei37 commented Nov 19, 2023

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 yunwei37 added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Nov 19, 2023
@Viveksati5143
Copy link
Contributor

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.

@yunwei37
Copy link
Member Author

Thanks!

@yunwei37
Copy link
Member Author

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

So please update the documents there

@yunwei37
Copy link
Member Author

yunwei37 commented Feb 25, 2024

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.

@Viveksati5143
Copy link
Contributor

Sure, looking into it,..

@Viveksati5143
Copy link
Contributor

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?

@yunwei37
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants