search

mozilla / legal-docs

Legal documents and more for Mozilla
https://mozilla.github.io/legal-docs/
Other
46 stars 105 forks source link

Restructure Legal doc repo #1501

Closed peiying2 closed 3 years ago

peiying2 commented 4 years ago

Goal:

Review current asset:

Create a branch to reflect the new structure [x] Create a branch in legal repo and rearrange the files accordingly [x] Create a branch in Bedrock and update relevant files accordingly to reflect the new structure.

QA the flow [x] Test the flow and confirm it works [x] Share info with teams with direct integration and allow time for them to make necessary changes.

Switch to new structure

Special asks - nice to have, :). [ ] CI automation [ ] Metadata file that shows which doc is localized in which languages. Example: https://github.com/mozmeao/www-l10n/tree/master/metadata [x] Standardize file name convention (Title case vs. lower case, etc).

peiying2 commented 4 years ago

@pmac I made a laundry list of things we discussed, it needs some tweaking to reflect what is going to be done and what is not.

@mafeld @litkaemily Please review the legal repo now and help us identify which products/projects are EOLed (can be archived) or are obsolete but in maintenance mode. If you know any products that are directly integrated with this repo, we/I should contact the team so they can be prepared with the switch. I have contacted FxA and Common Voice.

pmac commented 4 years ago

@peiying2 to be clear, you're asking that docs that are currently named <doc-name>/en-US.md to now be named en/<doc-name>.md right? Flipping the structure, but also moving current en-US content to just en and reserving en-US for actual US specific docs.

peiying2 commented 4 years ago

@peiying2 to be clear, you're asking that docs that are currently named <doc-name>/en-US.md to now be named en/<doc-name>.md right? Flipping the structure, but also moving current en-US content to just en and reserving en-US for actual US specific docs.

Yes. I don't know how complicated this could be, I believe half of the docs, or at least 1/3 don't have any localized content. Is there a way to figure this out with some kind of script? If not, I can manually go through the ones I have know we have not done anything with and list those in a google doc/spreadsheet.

pmac commented 4 years ago

Here is the full list of docs with every locale in the current repo ordered by number of locales:

firefox_reality_about_rights: en-US
firefox_monitor_terms_privacy: en-US
Fx_Screenshots_Privacy_Notice: en-US
Firefox_FireTV_Privacy_Notice: en-US
Mobile_Partner_Website_Agreements: zh-CN
Firefox_Private_Network_Beta_Privacy_Notice: en-US
Firefox_Private_Network_ToS: en-US
persona_tos: en-US
better_web_privacy: en-US
Mozilla_Hubs_ToS: en-US
thunderbird_privacy_policy: en-US
firefox_relay_privacy_notice: en-US
firefox_lite_about_rights: en-US
firefox_relay_ToS: en-US
report_infringement: en-US
Fx_Screenshots_TOS: en-US
Common_Voice_Challenge_Terms: en
thunderbird_about_rights: en-US
persona_privacy: en-US
Mozilla_Hubs_Privacy_Notice: en-US
facebook_privacy_info: en-US
firefox_reality_privacy_notice: en-US
Privacy-Notice-Summary: en-US
better_web_terms: en-US
Mozilla_VPN_ToS: en-US, ms
firefox_testpilot_Terms: de, en-US
Mobile_Partner_Website_Prototype_Agreement: zh-CN, en-US
OSSN_site_privacy_notice: es, en-US
firefox_testpilot_PrivacyNotice: de, en-US
firefox-cliqz_privacy_notice: de, en-US
klar_privacy_notice: de, en-DE
marketplace_preloaded_apps_terms: en-US, ja
firefox_screenshotgo_privacy_notice: id, en-US
focus_privacy_notice: de, en-US
firefox_screenshotgo_about_rights: id, en-US
mozilla_vpn_privacy_notice: en-US, ms
Mobile_Partner_Website_Branding_Terms: zh-CN, en-US
firefox_lite_contentservices_ToS: ml, hi, zh-TW, ta, id, en-US, tl, su, th, jv, kn, vi
firefox_lite_contentservices_reward: ml, hi, zh-TW, ta, id, en-US, tl, su, th, jv, kn, vi
firefox_about_rights: ro, it, nl, fr, de, zh-TW, pt-BR, zh-CN, en-US, es-ES, ja, ru, pl
firefox_lite_privacy_notice: ml, hi, zh-TW, zh-CN, ta, id, en-US, tl, su, th, jv, kn, vi
WebRTC_ToS: ro, it, bn, sr, hu, hi, cs, fr, de, pt-BR, ta, en-US, es-ES, ja, hr, ru, mk, el, pl
WebRTC_PrivacyNotice: ro, it, bn, sr, hu, hi, cs, fr, de, pt-BR, ta, en-US, es-ES, ja, hr, ru, mk, el, pl
Websites_ToU: ro, sw, ar, it, bn, sr, hu, hi, cs, fr, de, pt-BR, ta, tl-PH, en-US, es-ES, ja, hr, ru, mk, el, pl
acceptable_use_policy: en-US_b, tr, it, bn, sr, hu, hi, cs, nl, fr, de, pt-BR, zh-CN, ta, id, en-US, es-ES, ja, hr, ru, mk, el, pl
marketplace_developer_agreement: ro, sw, ar, it, bn, sr, hu, hi, cs, fr, de, pt-BR, zh-CN, ta, tl-PH, en-US, es-ES, ja, hr, ru, mk, el, pl
marketplace_privacy_policy: ro, sw, ar, zu, it, bn, sr, hu, xh, hi, cs, fr, de, pt-BR, zh-CN, ta, tl-PH, af, en-US, es-ES, ja, hr, ru, mk, el, pl
firefox_privacy_notice: en-US_b, ro, tr, es-MX, it, bn, sr, hu, hi, cs, nl, fr, de, zh-TW, pt-BR, zh-CN, ta, id, en-US, es-ES, ja, hr, ru, mk, el, pl
marketplace_terms_of_use: ro, sw, ar, zu, it, bn, sr, hu, xh, hi, cs, fr, de, pt-BR, zh-CN, ta, tl-PH, af, en-US, es-ES, ja, hr, ru, mk, el, pl
firefox_cloud_services_PrivacyNotice: ro, sw, ar, zu, it, bn, sr, hu, xh, hi, cs, fr, de, pt-BR, zh-CN, ta, tl-PH, af, en-US, es-ES, ja, hr, ru, mk, el, pl
firefox_cloud_services_ToS: ro, sw, tr, ar, zu, it, bn, sr, hu, xh, hi, cs, nl, fr, de, pt-BR, zh-CN, ta, id, tl-PH, af, en-US, es-ES, ja, hr, ru, mk, el, pl
websites_privacy_notice: ro, sw, tr, ar, it, bn, sr, hu, hi, cs, nl, fr, de, zh-TW, pt-BR, zh-CN, ta, id, en-US, es-ES, ja, tl, hr, th, ru, mk, el, vi, pl
firefox_os_privacy_notice: ro, sw, tr, ar, zu, it, sk, lt-LT, bn, sr, hu, xh, sv, hi, cs, nl, fr, fa, de, zh-TW, pt-BR, da, zh-CN, ta, nb-NO, id, my, tl-PH, af, en-US, es-ES, ja, he, bg, lt-
LV, hr, fi, th, ru, mk, el, et, sl, vi, pl
mozilla_privacy_policy: ro, sw, tr, ar, zu, it, sk, lt-LT, bn, sr, hu, xh, sv, hi, cs, nl, fr, fa, de, zh-TW, pt-BR, da, zh-CN, ta, nb-NO, id, my, af, en-US, es-ES, ja, he, bg, tl, lt-LV, hr
, fi, th, ru, mk, el, et, sl, vi, pl
Common_Voice_Privacy_Notice: eo, ro, br, rw, tr, ar, cnh, cv, it, sk, es, as, mt, kab, en, sv, dv, uk, cs, nl, fr, fa, ga, pa, de, fy, sah, zh-TW, zh-CN, ca, cy, id, ab, ky, ja, he, sq, tt,
rm, ru, mk, eu, el, et, sl, pt, lv, kk, pl, mn
Common_Voice_Terms: eo, ro, br, rw, tr, ar, cnh, cv, it, sk, es, as, mt, kab, en, sv, dv, uk, cs, nl, fr, fa, ga, pa, de, fy, sah, zh-TW, zh-CN, ca, cy, id, ab, ky, ja, he, sq, tt, rm, ru, m
k, eu, el, et, sl, pt, lv, kk, pl, mn
peiying2 commented 4 years ago

An observation I have but I don't expect us to fix is the title case vs lower case in doc names. I don't know at what point this ended up like this.

pmac commented 4 years ago

Consistency would be nice, but would also require some coordination to fix. We could do it now if you'd like while we're doing the coordination for the restructure.

peiying2 commented 4 years ago

Consistency would be nice, but would also require some coordination to fix. We could do it now if you'd like while we're doing the coordination for the restructure.

If we can get this done without too much hassle, let's tackle them while we have this opportunity.

pmac commented 4 years ago

I'd vote for all lower-case and underscore separated then (a.k.a. snake case).

pmac commented 4 years ago

I opened a draft PR so that folks can see what we're proposing. I can keep that updated until we figure out all of the integrations that need to be updated as well.

pmac commented 4 years ago

I now also have a draft PR open in bedrock (linked above) that supports both repo layouts to make the transition very easy.

litkaemily commented 4 years ago

Hi, circling back with a list of EOLed products/projects. Please let me know how else I can support this.

Common Voice Challenge Terms Firefox Cliqz Privacy Notice Firefox Cloud Services Privacy Notice Firefox OS Privacy Notice Firefox Screenshotgo About Rights Firefox Screenshotgo Privacy Notice Firefox Screenshots Privacy Notice Firefox Screenshots Terms Firefox Testpilot Privacy Notice Firefox Testpilot Terms Marketplace Developer Agreement Marketplace Preloaded Apps Terms Marketplace Privacy Policy Marketplace Terms Persona Privacy Policy Persona Terms WebRTC Privacy Notice WebRTC Terms

On Thu, Oct 29, 2020 at 5:20 PM Paul McLanahan notifications@github.com wrote:

I now also have a draft PR open in bedrock (linked above) that supports both repo layouts to make the transition very easy.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mozilla/legal-docs/issues/1501#issuecomment-719029018, or unsubscribe https://github.com/notifications/unsubscribe-auth/APKCGO5ERBBGSKSH7EH6DM3SNHMA5ANCNFSM4TAJHK4Q .

-- Emily Litka Product & Privacy Counsel emily@mozilla.com

peiying2 commented 4 years ago

@litkaemily Thanks so much for providing the above list (I sorted in alphabetical order so it is easy to spot what's missing), is firefox_cloud_services_ToS also EOLed? How about klar_privacy_notice?

We can also get your (plural) help on what products that are implemented directly with the repo? If not, we all need to ask teams about it. How are the legal docs integrated with mobile products?

litkaemily commented 4 years ago

Hi Peiying,

The only EOLed products/projects are the ones listed in my previous email.

Thanks! Emily

On Thu, Oct 29, 2020 at 6:16 PM Peiying notifications@github.com wrote:

@litkaemily https://github.com/litkaemily Thanks so much for providing the above list, is firefox_cloud_services_ToS also EOLed? How about klar_privacy_notice?

We can also get your (plural) help on what products that are implemented directly with the repo? If not, we all need to ask teams about it. How are the legal docs integrated with mobile products?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mozilla/legal-docs/issues/1501#issuecomment-719055029, or unsubscribe https://github.com/notifications/unsubscribe-auth/APKCGO6MSQZ5NRRKKLGFBVTSNHSSNANCNFSM4TAJHK4Q .

-- Emily Litka Product & Privacy Counsel emily@mozilla.com

peiying2 commented 4 years ago

@litkaemily the reason I asked is because you listed Firefox Cloud Services Privacy Notice as EOL but the ToS is not included in the list.

litkaemily commented 4 years ago

Thanks for checking in on this. That's right -- the Notice is EOLed and the ToS is still live.

Please let me know if there are other questions! Emily

On Fri, Oct 30, 2020 at 12:11 PM Peiying notifications@github.com wrote:

@litkaemily https://github.com/litkaemily the reason I asked is because you listed Firefox Cloud Services Privacy Notice as EOL but the ToS is not included in the list.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mozilla/legal-docs/issues/1501#issuecomment-719646029, or unsubscribe https://github.com/notifications/unsubscribe-auth/APKCGO47AXOFPVLAXQMNNA3SNLQTFANCNFSM4TAJHK4Q .

-- Emily Litka Product & Privacy Counsel emily@mozilla.com

pmac commented 4 years ago

One of these documents is still on the site:

Are we okay to remove that URL? Should it be redirected somewhere if so?

mafeld commented 4 years ago

I believe there's an archive where other sunsetted Mozilla products have gone.

Michael Feldman Product Counsel mfeldman@mozilla.com

On Mon, Nov 2, 2020 at 2:12 PM Paul McLanahan notifications@github.com wrote:

One of these documents is still on the site:

Are we okay to remove that URL? Should it be redirected somewhere if so?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mozilla/legal-docs/issues/1501#issuecomment-720753330, or unsubscribe https://github.com/notifications/unsubscribe-auth/APAJQFOASH6RMQOH3GWTP53SN4VETANCNFSM4TAJHK4Q .

peiying2 commented 3 years ago

I believe there's an archive where other sunsetted Mozilla products have gone.

@pmac this might be what @mafeld is referring to: https://www.mozilla.org/en-US/privacy/, click on the Outdated Policies - not user friendly. More doc oriented than product.

pmac commented 3 years ago

Oh yeah! I'd forgotten about that section. Shall I move the FxOS Privacy notice there?

litkaemily commented 3 years ago

Yes! Here's a list of the EOL'd projects:

Firefox Cliqz Privacy Notice

WebRTC Privacy Notice

WebRTC Terms

Firefox Testpilot Privacy Notice

Firefox Testpilot Terms

Marketplace Developer Agreement

Marketplace Preloaded Apps Terms

Marketplace Privacy Policy

Marketplace Terms

Persona Privacy Policy

Persona Terms

Common Voice Challenge Terms

Firefox Screenshots Privacy Notice

Firefox Screenshots Terms

Firefox OS Privacy Notice

Firefox Screenshotgo About Rights

Firefox Screenshotgo Privacy Notice

Firefox Cloud Services Privacy Notice

On Wed, Nov 11, 2020 at 11:46 AM Paul McLanahan notifications@github.com wrote:

Oh yeah! I'd forgotten about that section. Shall I move the FxOS Privacy notice there?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mozilla/legal-docs/issues/1501#issuecomment-725624920, or unsubscribe https://github.com/notifications/unsubscribe-auth/APKCGO5MUAJ7SWPMNUXK43LSPLS2ZANCNFSM4TAJHK4Q .

-- Emily Litka Product & Privacy Counsel emily@mozilla.com

peiying2 commented 3 years ago

@pmac want to sync up with you on what I have gathered on the teams with direct integration with the repo.

I am waiting for the delivery of the legal doc localization (see bug 1666941), due back by Dec 18th.

The only outstanding docs are the Fx Lite - I am waiting for an answer on their status from Sheila, to keep or to archive.

peiying2 commented 3 years ago

Update: Spoke to current owner D. Bolter on this. He needs to look into the Firefox Lite source code to confirm how the legal docs are integrated first thing in Jan.

peiying2 commented 3 years ago

@pmac thanks for this huge milestone to restructure the repo. I do want to follow up with "two nice to haves": [ ] CI automation [ ] Metadata file that shows which doc is localized in which languages. Example: https://github.com/mozmeao/www-l10n/tree/master/metadata

Is it possible? Which one is the low hanging fruit that we can have. I am concerned with the localized content that is pushed back to the repo with different markups and some will cause problems to layout.

pmac commented 3 years ago

What would you like for CI automation to do other than update the metadata files?

peiying2 commented 3 years ago

This is one thing I am not too clear as we are working on mozorg with Smartling. Legal doc update is not so frequent so I can at least keep an eye on it when the project is done. My main concern is (in addition to the markup issues not resolved), what other problems may surface, and the script would alert me either through the repo so I can have it fixed in Smartling and attempt another push.

Right now, mozorg is automatic without a PR so it is automated. I am not sure we have a way to capture anything if the translation breaks the code. Usually there is a warning (like variables) in the platform and the translator fixes it before it can be accepted.

pmac commented 3 years ago

We don't really have automated checks for these documents the way we do for the Fluent strings. Fluent files are structured data and have to have the proper format, whereas Markdown is much more free form. The main thing to do is to keep an eye on updates and watch for broken pages on www-dev.allizom.org. The changes only go to production when they're merged to the prod branch.

peiying2 commented 3 years ago

Let's see how it works out - or how error prone it will become. I am afraid of the new element added to the returned file like extra spaces. I have yet to set up the testing cases. Too many distractions lately.