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

Remove all TODOs from the docs #758

Open
4 tasks
vringar opened this issue Oct 6, 2020 · 9 comments
Open
4 tasks

Remove all TODOs from the docs #758

vringar opened this issue Oct 6, 2020 · 9 comments
Assignees

Comments

@vringar
Copy link
Contributor

vringar commented Oct 6, 2020

The following things need to be done:

  • Document the navigation instrument
  • Document the callstack instrument
  • Document the DNS instrument
  • Document how http_redirects works now
@vringar
Copy link
Contributor Author

vringar commented Oct 6, 2020

Anybody who wants to work on one of these things can have that broken out into a separate issue. Though I hope that @englehardt and I will just sit down and write these things out in a session.

@joy2306
Copy link

joy2306 commented Oct 6, 2020

Hi @vringar i would like to work on this , although i might need some help from the start as this is my first time working on open source .

@vringar
Copy link
Contributor Author

vringar commented Oct 6, 2020

Hey @joy2306,
thanks for choosing OpenWPM for your first open source contribution.
However I'm afraid that this issue isn't suitable for a beginner.
Do you want to have a look at #679 and tell me if that seems interesting to you?
Please don't worry about being a beginner, the issue I'm suggesting is quite simple in its implementation and I am willing to help you get familiar with the process.

@joy2306
Copy link

joy2306 commented Oct 6, 2020

Hey @vringar i saw the issue and couldn't interpret it properly as to what its asking , so if you can just help me out it would have been easier

@ankushduacodes
Copy link
Contributor

@vringar I would love to work on this alongside #495, I want to understand the platform better. I was also looking into web instrumentation yesterday but could not find any significant resources on it, Do you think this will be a good learning opportunity?

@ankushduacodes
Copy link
Contributor

ankushduacodes commented Dec 2, 2020

@vringar just a friendly reminder for this comment 😃

@vringar
Copy link
Contributor Author

vringar commented Dec 2, 2020

Go right ahead. I might be a little less available the next couple of weeks as I try to finally get #753 done, so you might be stuck on questions a little while longer, but feel free to explore!

@ankushduacodes
Copy link
Contributor

Go right ahead. I might be a little less available the next couple of weeks as I try to finally get #753 done, so you might be stuck on questions a little while longer, but feel free to explore!

For sure, could you please give a starting point as to what and where to explore. And if there is some readings to do, I will be happy to do it

@vringar
Copy link
Contributor Author

vringar commented Dec 2, 2020

I think the DNS instrument is the best place to start as the other 3 topics are pretty advanced and go deep into firefox.
As for reading on the DNS instrument I would suggest reading the source and trying to find the PR it was introduced in to have a look at what we discussed there.

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