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.

Sign up for GitHub

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

Jump to bottom

Convert legal PDFs to markdown #868

Merged
merged 15 commits into from Apr 25, 2020
Merged

Convert legal PDFs to markdown #868

merged 15 commits into from Apr 25, 2020

Conversation

purpledrosophila
Copy link
Contributor

@purpledrosophila purpledrosophila commented Apr 4, 2020 •
edited by brunobowden

Please follow this checklist. Please check each appropriate box (put an 'x' or check it after creating the PR).

  • [ x] REQUIRED: Do you have an Issue assigned to you within the v1 milestone for this PR? Put the Issue number here: 812
  • Provided detailed pull request description and a succinct title (consider template below for guidance).
  • [ x] Tested your changes, especially after any code review iterations.
  • [ x] Included any relevant screenshots of UI updates. (N/A)
  • [x ] Followed the Contributor Guidelines.
  • [x ] Verified all contributions are properly licensed pursuant to the LICENSE file in the root of the repository.
  • [x ] Verified your name is in the content/credits.yaml file (if you want it to be).

After all boxes above are checked, request and receive an Approved review from any team member knowledgable in the area (TODO team member list). Once approved, the team member will assign your review to a Committer or use the needs-merge label.

What does this PR accomplish?

Converts legal PDFs to Markdown as start of accessibility edits.

This handles the simple conversion, but I have noticed some inconsistencies in phrasing and places where terms could be clarified. I would also suggest creating a legal terms glossary as part of the issue this request addresses. Running the text through Readable.org also showed that we could potentially simplify and clarify the text; I suggest we do that before closing this issue.

812 -- Recommend not closing this yet.

Did you add any dependencies?

How did you test the change?

Checked to make sure Markdown was valid.

@advayDev1
Copy link
Contributor

Thanks @purpledrosophila - we shouldn't change any of the wording except through advice by legal counsel.

Can you confirm this is an exact copy of the current PDFs?

@purpledrosophila
Copy link
Contributor Author

@advayDev1 Yes, I can confirm. The only thing I changed was a whitespace error that I caught while converting. Somebody forgot a space between a couple words, and I fixed it.

@advayDev1 advayDev1 added the blocked Do not merge this PR or work on this issue label Apr 4, 2020
britannio
britannio previously requested changes Apr 4, 2020
View reviewed changes
docs/TERMS.md Outdated Show resolved Hide resolved
docs/PRIVACY.md Outdated
Comment on lines 40 to 44
* Apple Store (iTunes Store) (Privacy Policy)
* Google Analytics (Privacy Policy and Terms)
* Google Cloud (Privacy Policy)
* Google Firebase (Privacy Policy)
* Google Play Store (Privacy Policy)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* Apple Store (iTunes Store) (Privacy Policy)
* Google Analytics (Privacy Policy and Terms)
* Google Cloud (Privacy Policy)
* Google Firebase (Privacy Policy)
* Google Play Store (Privacy Policy)
* Apple Store (iTunes Store) ([Privacy Policy](https://www.apple.com/legal/privacy/en-ww/))
* Google Analytics ([Privacy Policy](https://support.google.com/analytics/answer/6004245) and [Terms](https://www.google.com/analytics/terms/))
* Google Cloud ([Privacy Policy](https://cloud.google.com/security/privacy))
* Google Firebase ([Privacy Policy](https://firebase.google.com/support/privacy))
* Google Play Store ([Privacy Policy](https://policies.google.com/privacy?hl=en&gl=us))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed. Will commit in just a minute when I fix the rest of this page's requests.

docs/PRIVACY.md Outdated Show resolved Hide resolved
britannio
britannio reviewed Apr 4, 2020
View reviewed changes
docs/PRIVACY.md Outdated Show resolved Hide resolved
@purpledrosophila
Update TERMS.md
3654017 
Added privacy policy link.
@purpledrosophila
Update PRIVACY.md
09901cd 
Added links where necessary.
@purpledrosophila
Copy link
Contributor Author

All links should be updated now. Anything else I should tweak?

@avkvirtru avkvirtru mentioned this pull request Apr 6, 2020
Closed
avkvirtru
avkvirtru reviewed Apr 6, 2020
View reviewed changes
Copy link
Contributor

@avkvirtru avkvirtru left a comment

Choose a reason for hiding this comment

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

There are minor content mismatches going from PDF to Markdown: 2 dashes inserted and a corrected spelling. Not sure who should decide if these should change…

docs/PRIVACY.md Outdated

The use of data described in the WHO Privacy Policy applies to the Service. Additionally, we use Usage Data to enable participation in interactive features of our Service and to provide you with information if you opt into receiving information through the Service or engage with interactive features.

## Third-Party Apps and Services
Copy link
Contributor

Choose a reason for hiding this comment

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

Content mismatch: "Third Party" doesn't have a dash in the current privacy.pdf

docs/PRIVACY.md Outdated

## Third-Party Apps and Services

Third-party applications and/or services linked to or embedded in the App governed by those third-party security and privacy policies (see [third party tools][8]). If you consent to receiving push notifications, a third-party provider may collect device and regional location information, but your identity or Personal Data will not be revealed to us as a result of enabling such notifications. You may stop push notifications by adjusting your device settings.
Copy link
Contributor

Choose a reason for hiding this comment

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

Content mismatch: "third party provider" doesn't have a dash in the current privacy.pdf

docs/PRIVACY.md Outdated

## Data Retention and Transfer

We retain and use Personal Data and Usage Data only as long as is necessary for the purposes set out in our Privacy Policy and this Privacy Notice, or to the extent necessary to comply with legal obligations, resolve disputes, or enforce legal agreements and policies. We transfer the data, including Personal Data, to the U.S.A. for processing and storage, and by using or submitting information via the Service you consent to such transfer.
Copy link
Contributor

Choose a reason for hiding this comment

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

Content mismatch: "Useage Data" in the current privacy.pdf

The original word "useage" does appear to be a misspelling in American and British English. But I would confirm even typos with legal…

@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 6, 2020 via email

@avkvirtru
Copy link
Contributor

@purpledrosophila @britannio I'm surprised this PR doesn't remove the server-side PDFs or the routing to them:

    serve("/terms").with(forwardTo("/terms.pdf"));
    serve("/privacy").with(forwardTo("/privacy.pdf"));

(from https://github.com/WorldHealthOrganization/app/blob/master/server/appengine/src/main/java/who/WhoServletModule.java#L25)

Also seems like we'd have to serve HTML, not Markdown at those URLs.

I can't test the accessibility of the content in the app without being able to navigate to these new terms and privacy policy from within the app.

@britannio
Copy link
Collaborator

@avkvirtru I was completely oblivious to those files. If we switched from PDFs to HTML then the link in the app would show a website instead of downloading a PDF. The other option was converting the PDFs to markdown and displaying the markdown in the app, that way it's also version controlled.

Maybe now is the time to decide what should actually be done, from a legal side are there any rks of showing a static TOS & PP in the event that we update them?

@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 6, 2020 via email

@avkvirtru
Copy link
Contributor

@avkvirtru I was completely oblivious to those files. If we switched from PDFs to HTML then the link in the app would show a website instead of downloading a PDF. The other option was converting the PDFs to markdown and displaying the markdown in the app, that way it's also version controlled.

@britannio the current approach is to show a web view in the app that renders those PDFs. HTML makes the most sense to me.

@advayDev1
Copy link
Contributor

First - thank you!

Can you make sure these are in a docs/legal folder?

We can then add some rules to make sure they are reviewed by legal before they get committed unlike all other parts of the codebase.

@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 6, 2020 via email

@advayDev1
Copy link
Contributor

Every document needing legal counsel review can be in docs/legal

@advayDev1 advayDev1 added the legal Legal tasks label Apr 6, 2020
@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 6, 2020 via email

@britannio
Copy link
Collaborator

Is that everything currently in the docs folder, then?

I believe you need to create a legal folder under docs and place the markdown files there.
i.e. docs/legal/TERMS.md instead of docs/TERMS.md

@advayDev1 advayDev1 removed the blocked Do not merge this PR or work on this issue label Apr 17, 2020
advayDev1
advayDev1 suggested changes Apr 17, 2020
View reviewed changes
Copy link
Contributor

@advayDev1 advayDev1 left a comment

Choose a reason for hiding this comment

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

Please confirm all differences between most recent pdfs and master

@advayDev1 advayDev1 self-assigned this Apr 17, 2020
@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 17, 2020 via email

@purpledrosophila
Copy link
Contributor Author

OK, something weird is going on with my GitHub setup, and I'm not sure what it is. I'm trying to work on another issue, can't seem to do it, and can't seem to update my repository, for some reason. I've been trying to figure out what's going on, not having much success. If I delete my fork and the branch attached to this pull request, will we have to create a new issue for this? I'm sorry about this issue; I'm really not sure what's going on. I've got the updated Markdown, though; I just need the links to the PDFs again to make sure that they're the same.

@purpledrosophila
Copy link
Contributor Author

OK, sorry for the spamming, I think I somehow managed to update my branch properly. Once I have the old PDFs in hand to double-check one more time, we should be good.

@advayDev1
Copy link
Contributor

@purpledrosophila https://whoapp.org/privacy https://whoapp.org/terms

@advayDev1
Copy link
Contributor

@purpledrosophila how's this going

@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 25, 2020 via email

@purpledrosophila
Update PRIVACY.md
01e5dda 
Made sure "third party" is always 2 words with a space, for consistency with TERMS.
@purpledrosophila
Copy link
Contributor Author

Hi all,

I fixed a few typos in PRIVACY; other than that, the Markdown is an exact match to the PDFs. The Third Party Tools section looks a little different in the Markdown, but that was by request; if you want me to change it back let me know.

I noticed a few more things we may want to check with legal for the sake of clarity. Note that I did not make these changes yet, I'm just suggesting them. As far as I can tell, the content of the files is good, no more changes are essential.

Under "Prohibited Uses" in TERMS, the PDF says:

"You agree not to use the App in any way that is unlawful, illegal or unauthorised; advocates, promotes or assists any unlawful; or is likely to disrupt the Service."

Shouldn't it say:

"You agree not to use the App in any way that is unlawful, illegal or unauthorised; advocates, promotes or assists any unlawful activities; or is likely to disrupt the Service."

Seems like a word might have been missed there?

Also, in terms of clarity -- TERMS says this:

"THE APP IS IN NO WAY TO BE CONSIDERED OR USED AS A REPLACEMENT FOR PERSONAL PROFESSIONAL MEDICAL ADVICE FROM YOUR DOCTOR."

Wouldn't it be clearer to say:

"THE APP IS IN NO WAY TO BE CONSIDERED OR USED AS A REPLACEMENT FOR PROFESSIONAL MEDICAL ADVICE FROM YOUR PERSONAL DOCTOR."

"Personal professional" seems like it could be confusing.

Lastly, just a thought from me -- I ran TERMS and PRIVACY through a readability analyzer, and they have higher reading levels than they probably should if we want people to understand them. PRIVACY has a reading level of 9.8, which isn't that bad, but an ideal would be 8 or lower, as in an 8th grade reading level. TERMS has a reading level of over 13, which means no one hasn't completed at least some college could read it easily. I'm aware that things have to be phrased in "legalese" to some degree, but is there any way we could simplify them a bit? I figure that the more understandable these are, the better off WHO will be.

@advayDev1
Copy link
Contributor

@purpledrosophila hope you're feeling better and thank you!

@stephliu I'll get the current version in - can you sync with counsel on the suggestions @purpledrosophila made?

@advayDev1
Copy link
Contributor

@purpledrosophila what typos did you change? third-party should keep its hyphen when used as an adjective

@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 25, 2020 via email

@advayDev1
Copy link
Contributor

third party as a noun and third-party as an adjective. Let's go back to whatever counsel had, and Stephanie will coordinate the on-going changes with counsel.

@purpledrosophila
Copy link
Contributor Author

purpledrosophila commented Apr 25, 2020 via email

purpledrosophila and others added 3 commits April 25, 2020 14:35
@purpledrosophila
Update PRIVACY.md
0394191 
Fixed: "third party" = noun, "third-party" = adjective
@purpledrosophila
Update TERMS.md
c34b77a 
Fixed: "third party" = noun, "third-party" = adjective
@purpledrosophila
Merge remote-tracking branch 'upstream/master' into pdf-to-markdown
e35fb5e
advayDev1
advayDev1 approved these changes Apr 25, 2020
View reviewed changes
Copy link
Contributor

@advayDev1 advayDev1 left a comment

Choose a reason for hiding this comment

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

Approving solely for markdown conversion, and not legal content

@advayDev1 advayDev1 merged commit fd41815 into WorldHealthOrganization:master Apr 25, 2020
@purpledrosophila purpledrosophila deleted the pdf-to-markdown branch April 25, 2020 19:55
@purpledrosophila
Copy link
Contributor Author

@advayDev1 Do you want me to create another issue for the text of these documents?

@advayDev1
Copy link
Contributor

Sure go for it @purpledrosophila

Chheomtit1993
Chheomtit1993 reviewed Sep 20, 2020
View reviewed changes
Copy link

@Chheomtit1993 Chheomtit1993 left a comment

Choose a reason for hiding this comment

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

Chheomtit1993![Uploading 93710574...]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@britannio britannio britannio left review comments

@avkvirtru avkvirtru avkvirtru left review comments

@Chheomtit1993 Chheomtit1993 Chheomtit1993 left review comments

@advayDev1 advayDev1 advayDev1 approved these changes

@brunobowden brunobowden Awaiting requested review from brunobowden brunobowden is a code owner

@crazybob crazybob Awaiting requested review from crazybob

@hspinks hspinks Awaiting requested review from hspinks

@SamMousa SamMousa Awaiting requested review from SamMousa

Assignees

@advayDev1 advayDev1

Labels
docs Improvements or additions to documentation legal Legal tasks
Projects
None yet
Milestone
v1.0 - Nigeria
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@purpledrosophila @advayDev1 @avkvirtru @britannio @epicfaace @Chheomtit1993 @SamMousa