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

Please help us for Tutorial wiki page update #768

Open
honggyukim opened this issue May 16, 2019 · 5 comments
Open

Please help us for Tutorial wiki page update #768

honggyukim opened this issue May 16, 2019 · 5 comments

Comments

@honggyukim
Copy link
Collaborator

honggyukim commented May 16, 2019

Hello folks,

The tutorial wiki page is written a long time ago and it really needs to be updated.
https://github.com/namhyung/uftrace/wiki/Tutorial

I think that the tutorial page is the entry point to new users, so it is also important as well as the uftrace code update.

However, the project is almost managed by volunteers so we don't have enough time and resource to carefully read and update the tutorial all the time.

So we would like to invite anyone to help and update the Tutorial page. If you're a new comer, that's okay. Please read the tutorial and if you think that the contents are not understandable or look incorrect, please let us know or you can just modify the document by yourself.

We would like to ask some help as follows:

  • Fixing outdated or incorrect contents
  • Better examples for uftrace features
  • English and grammar correction
  • Anything else that can be helpful

The wiki page is editable by anyone, so please help us to make the project better. Please DO NOT hesitate modifying the tutorial, we can manage it anyway.

Thanks very much for your help in advance.

@coleblackman
Copy link

coleblackman commented Jul 2, 2021

I updated the tutorial page, mostly fixing grammar issues and some formatting. A cursory look seems to indicate the content is still up to date, though if you have reason to think it' s not I'll go back through and execute each command with the sample programs to check. I also don't know whether command line flags have since been added/removed or not, but I think for a basic tutorial that's not a huge issue.

If you'd like I will do the same with the main README

Edit: I can also do the same thing for the other wiki pages such as https://github.com/namhyung/uftrace/wiki/Arguments if desired.

@namhyung
Copy link
Owner

namhyung commented Jul 2, 2021

Thanks a lot for your work! It'd be great if you could check other pages like you mentioned!

@honggyukim
Copy link
Collaborator Author

@coleblackman Thanks very much for your help. Please go ahead and let us know if you have some questions.

@coleblackman
Copy link

No problem. I have continued working on the other wiki pages. The content has been very helpful in optimizing my own usage of uftrace.

However, I can't quite figure out what the following snippet, taken from the first paragraph of the "Filters" wiki page, is trying to say. Can you rephrase it?

For this reason, it is generally better to apply filters on record while most of it works for other commands like replay, report, graph and dump too.

Feel free to assign the issue and I'll submit a pull request for the main README also. Thanks.

@honggyukim
Copy link
Collaborator Author

Sorry for the late response. the sentence you mentioned can be rephrased as

For this reason, it is generally better to apply filters during record time but almost all the filters can also be applied for other commands such as replay, report, graph, script and dump too.

I modified the sentence in the wiki myself. So don't worry to change it again.

Feel free to assign the issue and I'll submit a pull request for the main README also. Thanks.

If you find something to change in README, then it would also be helpful for us. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants