Legal documents and more for Mozilla
Перейти к файлу
Francesco Lodolo 340ea63d74
Publish documents to production (#2164)
Co-authored-by: MozMEAO Bot <MozmarRobot@users.noreply.github.com>
2024-11-19 10:09:32 -08:00
ar [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
cs [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
de [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
el [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
en Publish documents to production (#2164) 2024-11-19 10:09:32 -08:00
es [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
es-ES
es-MX
fr [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
hi [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
hu
id [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
it [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
ja [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
ko
ms [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
nl [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
pl [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
pt [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
pt-BR
ro [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
ru [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
sw [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
tr [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
uk [prod] Publish document updates (#2162) 2024-11-16 17:59:46 +01:00
ur [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
vi
zh-CN [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
zh-TW [prod] Publish document updates (#2159) 2024-11-14 14:41:41 +01:00
CODE_OF_CONDUCT.md
README.md
package.json

README.md

Mozilla Legal Documents

This repository contains legal documents and their applicable translations. Each subdirectory represents a single legal document. Within a document directory is a series of markdown files, each named for the language the document is written in. For instance, firefox_privacy_notice/de.md is the German version of the Firefox privacy policy.

Editing

If you're a member of the legal team, it's easy to get started. First, make sure you're logged in with your Github account. When you have a change which you wish to make, simply find the en-US.md version of the document that you wish to change. Open it and press the Edit button. If you have never gone through this process before, you will be asked to "fork" the repository (you should).

On the edit page, you'll be presented with a "raw" version of the legal document. Edit the text you wish to change. When you are done editing, there will be a section at the bottom of the page to save your work. Under "Commit summary", enter a brief (tweet-length) description of the change(s) you're making. In the "Extended description" field, explain what the changes are and why they're needed. When you're done, commit your changes.

At this point, you'll be presented with a form to submit a pull request. The bottom section of the page will show all of the change you've made to the document, and all you should need to do is press the "Send Pull Request" button.

Once you've submitted a pull request, your colleagues can review the work under the Pull Requests tab on the right-hand side, and a contributor to the repo can merge your changes.

Markdown

These files are written in the Markdown syntax. In some languages, the date format contains dots like 15. travnja 2014. but this may end up as an ordered list according to the syntax. The workaround is using a backslash to escape a dot after the leading digit(s) like 15\. travnja 2014.

Some Markdown files use the Attribute Lists extension of the Python Markdown library. This is useful when you'd like to set the ID or class of an element, but the extended syntax may cause an error if your parser doesn't support this extension.

Localizers

As a localizer, you're encouraged to find and fix translation issues. All document translations should match the precise meaning in the corresponding en-US.md version of the document. Additionally, we're always interested in finding errors in markup, broken links, etc.

File a pull request that updates your locale's markdown file to match the en-US.md version as closely as possible. When you're done, submit a pull request. Someone at Mozilla will review your changes. If there are no problems, your changes will be merged.

Getting changes to production

For www.mozilla.org, the process is as follows:

  1. Go to: https://github.com/mozilla/legal-docs/compare/prod...master
  2. Look at the changes and make sure the changed docs look right on dev
  3. Click the "Create pull request" button
    • NOTE: If a "prod" pull request is already open this button will instead say "View pull request", and while it's open any new changes merged to master will show up in this pull request until it is merged.
  4. Fill in details on the form and click "Create pull request"
  5. Have a teammate review and click "Rebase and merge" or you can do it yourself if you are confident the changes are good and you have permission.
  6. Watch for the changes to be updated in production (could take a half-hour or so)

URL Inventory

Following is a list of directories in this repository and either their URL counterparts on the web or directions to see the document in case it isn't easily linkable. The URLs below will link to the English (US) versions of the document but replacing en-US in the URL with an available language code will show alternative languages.

Generally speaking Privacy Notice documents will be at https://www.mozilla.org/privacy/ and Terms documents at https://www.mozilla.org/about/legal/.