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

OONI Probe Mobile User Guide Update, 3.7.0 app version #1202

Merged
merged 41 commits into from
Sep 6, 2022
Merged

OONI Probe Mobile User Guide Update, 3.7.0 app version #1202

merged 41 commits into from
Sep 6, 2022

Conversation

sloncocs
Copy link
Contributor

@sloncocs sloncocs commented Aug 2, 2022

  • Updated screenshots
  • Updated text of the user guide

Copy link
Member

@agrabeli agrabeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @sloncocs for the excellent and thorough work! <3

I have left some comments with minor feedback and suggested edits.

content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
- Typos fixed
- Formatting fixed
- Debug logs and crash reports descriptions and instructions changed
OONI Probe Desktop App, version 3.7.0
- Updated text and numbers
- Added links
@agrabeli
Copy link
Member

@sloncocs thank you for your thorough and amazing work on updating the OONI Probe Mobile guide! <3

I just finished reviewing your updates, and I've left some feedback as comments.

To help provide a version of the guide that can be reviewed and deployed on the OONI website, please take note / review the following:

  • It's important that images are jpeg or jpg in the markdwon depending on how those images are saved in the files. If, for example, we have uploaded an image saved as jpeg, but it's written as jpg in markdown, this won't be rendered properly and we won't be able to merge and deploy the changes. I'm mentioning this because I noticed several cases where jpeg and jpg were edited in the markdown, and many images don't render in the preview.
  • There might be other cases (either with images or text) where the markdown is not consistent/accurate, which may explain why a preview version cannot be deployed.

Thank you for your time and effort in updating this guide, and thank you for addressing my comments and checking the markdown. <3

Copy link
Member

@agrabeli agrabeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @sloncocs for your great work on updating the OONI Probe Desktop guide! <3

I just completed the review, and shared some feedback in the form of comments.

Similarly to my feedback for the OONI Probe Mobile guide, I'd suggest reviewing whether new images are formatted correctly (while being consistent with what is included in the relevant markdown sections), as well as checking for any other potential markdown issues that may be preventing deployment.

Thanks again for this great work! <3

content/support/ooni-probe-mobile/index.md Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-desktop/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-desktop/index.md Show resolved Hide resolved
content/support/ooni-probe-desktop/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-desktop/index.md Show resolved Hide resolved
content/support/ooni-probe-desktop/index.md Outdated Show resolved Hide resolved
sloncocs and others added 11 commits August 15, 2022 13:59
Added piece: 

As mentioned in the previous sections, we also use third-parties services to optimise our work:

* We use the open source [Matomo analytics platform](https://matomo.org/) to analyse the users' activity on our website. This platform does not use cookies and we do not track any personal data. We host this platform ourselves and do not collect any personal data to avoid any privacy-related risks for our users.
* On OONI Explorer, we also use Sentry to log crash reports, which helps us improve the service. These reports include only the information about your device which we need to address the crash reports. Please check [Sentry Privacy Policy](https://sentry.io/privacy/), if you are not sure you want to share any information with them, please opt-out of sharing crash reports with us in the settings of your application.
Added text: 

As mentioned in the previous sections, we also use third-parties services to optimise our work:

* We use the open source [Matomo analytics platform](https://matomo.org/) to analyse the users' activity on our website. This platform does not use cookies and we do not track any personal data. We host this platform ourselves and do not collect any personal data to avoid any privacy-related risks for our users.
* On OONI Explorer, we also use Sentry to log crash reports, which helps us improve the service. These reports include only the information about your device which we need to address the crash reports. Please check [Sentry Privacy Policy](https://sentry.io/privacy/), if you are not sure you want to share any information with them, please opt-out of sharing crash reports with us in the settings of your application.
Copy link
Member

@agrabeli agrabeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sloncocs I just finished reviewing the OONI Probe Desktop guide, and committed some edits. Thanks for the great work! I think the OONI Probe Desktop guide is ready for publication, once I've also reviewed the mobile guide and resolved Netlify issues.

content/support/ooni-probe-desktop/index.md Show resolved Hide resolved
content/support/ooni-probe-desktop/index.md Show resolved Hide resolved
Copy link
Member

@agrabeli agrabeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sloncocs I just finished reviewing the updates to the OONI Probe Mobile user guide, and committed several edits. Thank you for this great work! I think we may we ready to merge. :)

content/support/ooni-probe-mobile/index.md Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-mobile/index.md Outdated Show resolved Hide resolved
content/support/ooni-probe-desktop/index.md Outdated Show resolved Hide resolved
@agrabeli
Copy link
Member

agrabeli commented Sep 2, 2022

I'm doing some additional quality control now that I'm able to preview the guides on Netlify. I'll commit some other minor edits before merging.

@agrabeli
Copy link
Member

agrabeli commented Sep 2, 2022

@sloncocs the OONI Probe Desktop guide is ready for publication, but the OONI Probe Mobile guide still needs some work. I committed several edits that also include a bit of restructuring of text and images (where needed, as observed through the Netlify deployment preview).

Please make the following changes to the OONI Probe Mobile guide:

  1. Replace the screenshots under steps 3, 4, 5, 6 (https://deploy-preview-1202--ooni.netlify.app/support/ooni-probe-mobile#testing-websites-of-your-choice) so that they show that the HTTPS version of Facebook, Twitter and Gutenberg has been added (https://www.facebook.com, https://twitter.com, and https://www.gutenberg.org). This is an important detail to highlight to help ensure more accurate testing.

  2. Replace the screenshot under step 4 (https://deploy-preview-1202--ooni.netlify.app/support/ooni-probe-mobile#testing-all-websites-from-the-citizen-lab-test-lists) to show that the test limit duration has been disabled.

  3. Please write (and create screenshots for) the following 2 missing Settings sections:

I think once the above are done (and reviewed) we may be ready to publish both user guides. :)

Thanks so much for all your great work! I really love the new screenshots you added. <3

Copy link
Member

@agrabeli agrabeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sloncocs for addressing my feedback! I have reviewed the changes, and committed some edits to the "automated testing" and "OONI backend proxy" sections.

Final feedback: Please replace the 2nd screenshot under Step 5 (https://deploy-preview-1202--ooni.netlify.app/support/ooni-probe-mobile#testing-websites-of-your-choice) to say https://www.gutenberg.org (the URL is currently missing www, which is inconsistent with the text above).

Copy link
Member

@agrabeli agrabeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @sloncocs for addressing my final feedback, and thank you in general for the excellent work in updating the OONI Probe user guides! <3

I just reviewed the final versions, and I think we're ready for publication. :)

@agrabeli agrabeli merged commit f29c3ee into ooni:master Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants