fxa/README.md

[![pullreminders](https://pullreminders.com/badge.svg)](https://pullreminders.com?ref=badge)

## Firefox Accounts

The Firefox Accounts (fxa) monorepo

### Table of Contents

[Getting Started](#getting-started)\
[Contributing](#contributing)\
[Documentation](#documentation)
[Documentation for Scripts](#documentation-for-scripts)

---

### Getting Started

Please read [our documentation](https://mozilla.github.io/ecosystem-platform/tutorials/development-setup)

---

### Contributing

See the separate [CONTRIBUTING.md](https://github.com/mozilla/fxa/blob/main/CONTRIBUTING.md) to learn how to contribute.

---

### Documentation

The [Firefox Ecosystem Platform](https://mozilla.github.io/ecosystem-platform/) serves as a documentation hub for Firefox Accounts and Subscription Platform.

---

### Documentation for Scripts

#### \_scripts/legal-md-to-pdf.sh

##### Purpose

This bash script converts markdown documents into pdfs. The purpose is to provide an efficient way for Mozilla VPN legal documents to be converted and made available to end-users.

##### Usage

_Pre-requisites_: The script requires the following:

- Local copy of Mozilla legal-docs repo: https://github.com/mozilla/legal-docs
- pandoc: https://github.com/jgm/pandoc/blob/master/INSTALL.md
- LaTeX: https://www.latex-project.org/get/

##### To Run:

```bash
# from root fxa directory
_scripts/legal-md-to-pdf.sh '/absolute/path/to/legal-docs/'
```

The script traverses the legal-docs directory looking for localized copies of the Mozilla VPN legal documents. When found, the script converts the document from .md to .pdf and writes it to `assets/legal/<document_name>.<locale>.pdf`.

Example:
directory provided: `/Users/test/github/mozilla/legal-docs/`
resulting file: `assets/legal/<document_name>.<locale>.pdf`
Add pull reminder badge 2019-05-21 00:56:11 +03:00			`[![pullreminders](https://pullreminders.com/badge.svg)](https://pullreminders.com?ref=badge)`

prepare for monorepo 2019-03-30 04:22:03 +03:00			`## Firefox Accounts`
add install scripts 2014-11-05 04:38:23 +03:00
prepare for monorepo 2019-03-30 04:22:03 +03:00			`The Firefox Accounts (fxa) monorepo`
Add dev only note 2018-02-09 03:16:29 +03:00
chore(docs): Update root README to include table of contents plus links to ecosystem platform and Riot 2020-03-10 19:05:01 +03:00			`### Table of Contents`

			`[Getting Started](#getting-started)\`
			`[Contributing](#contributing)\`
			`[Documentation](#documentation)`
chore(docs): add details on Storybook in CircleCI to README.md 2021-04-17 02:28:38 +03:00			`[Documentation for Scripts](#documentation-for-scripts)`
chore(docs): Update root README to include table of contents plus links to ecosystem platform and Riot 2020-03-10 19:05:01 +03:00
			`---`

add install scripts 2014-11-05 04:38:23 +03:00			`### Getting Started`

docs(README): remove duplicate docs Because: * We have formal docs in another repository This commit: * Removes the duplicate docs 2022-01-08 03:48:18 +03:00			`Please read [our documentation](https://mozilla.github.io/ecosystem-platform/tutorials/development-setup)`
Clean up the getting started section. 2015-06-30 19:31:59 +03:00
feat: add vscode settings and extensions, update docs for docker-ce Update docs to reflect usage of docker-ce vs. outdated docker.io. Closes #1072. 2019-07-01 22:56:34 +03:00			`---`
add local testing 2015-05-08 23:19:01 +03:00
chore(docs): Update README/CONTRIBUTING for monorepo/commit signing. I moved the CONTRIBUTING.md file from the content server package to the top level so that it easily discoverable. The README now contains a link to CONTRIBUTING.md. CONTRIBUTING.md now mentions GPG signatures as a requirement for opening PRs. Not attached to an issue. 2019-04-22 15:14:02 +03:00			`### Contributing`

chore(docs): Replace 'master' with 'main' throughout Certain references to 'master' haven't been removed yet, see issue #5698, issue #5699, issue #5700 for more complex followups. 2020-06-18 04:13:10 +03:00			`See the separate [CONTRIBUTING.md](https://github.com/mozilla/fxa/blob/main/CONTRIBUTING.md) to learn how to contribute.`
chore(docs): Update README/CONTRIBUTING for monorepo/commit signing. I moved the CONTRIBUTING.md file from the content server package to the top level so that it easily discoverable. The README now contains a link to CONTRIBUTING.md. CONTRIBUTING.md now mentions GPG signatures as a requirement for opening PRs. Not attached to an issue. 2019-04-22 15:14:02 +03:00
feat: add vscode settings and extensions, update docs for docker-ce Update docs to reflect usage of docker-ce vs. outdated docker.io. Closes #1072. 2019-07-01 22:56:34 +03:00			`---`
chore(docs): add link to shrinkwrap updates Fixes mozilla/fxa-local-dev#63 2016-07-25 22:14:18 +03:00
chore(docs): Update root README to include table of contents plus links to ecosystem platform and Riot 2020-03-10 19:05:01 +03:00			`### Documentation`

docs(README): remove duplicate docs Because: * We have formal docs in another repository This commit: * Removes the duplicate docs 2022-01-08 03:48:18 +03:00			`The [Firefox Ecosystem Platform](https://mozilla.github.io/ecosystem-platform/) serves as a documentation hub for Firefox Accounts and Subscription Platform.`
chore (fxa script): create script to convert legal markdown files to pdfs Because: * Creating a script to aid in the conversion of entire directories or single markdown files to pdfs will reduce the amount of time spent on markdown to pdf conversion requests. This commit: * Provides a bash script to aid in the conversion process * Includes the initial legal docs required for the VPN services in the directory specified in the request: "/assets/legal" for review Closes #5718 2020-06-30 01:56:10 +03:00
			`---`

			`### Documentation for Scripts`

			`#### \_scripts/legal-md-to-pdf.sh`

			`##### Purpose`

Update legal-md-to-pdf.sh script and add resulting localized PDFs. 2021-03-09 22:36:22 +03:00			`This bash script converts markdown documents into pdfs. The purpose is to provide an efficient way for Mozilla VPN legal documents to be converted and made available to end-users.`
chore (fxa script): create script to convert legal markdown files to pdfs Because: * Creating a script to aid in the conversion of entire directories or single markdown files to pdfs will reduce the amount of time spent on markdown to pdf conversion requests. This commit: * Provides a bash script to aid in the conversion process * Includes the initial legal docs required for the VPN services in the directory specified in the request: "/assets/legal" for review Closes #5718 2020-06-30 01:56:10 +03:00
			`##### Usage`

Update legal-md-to-pdf.sh script and add resulting localized PDFs. 2021-03-09 22:36:22 +03:00			`_Pre-requisites_: The script requires the following:`
chore (fxa script): create script to convert legal markdown files to pdfs Because: * Creating a script to aid in the conversion of entire directories or single markdown files to pdfs will reduce the amount of time spent on markdown to pdf conversion requests. This commit: * Provides a bash script to aid in the conversion process * Includes the initial legal docs required for the VPN services in the directory specified in the request: "/assets/legal" for review Closes #5718 2020-06-30 01:56:10 +03:00
Update legal-md-to-pdf.sh script and add resulting localized PDFs. 2021-03-09 22:36:22 +03:00			`- Local copy of Mozilla legal-docs repo: https://github.com/mozilla/legal-docs`
chore (fxa script): create script to convert legal markdown files to pdfs Because: * Creating a script to aid in the conversion of entire directories or single markdown files to pdfs will reduce the amount of time spent on markdown to pdf conversion requests. This commit: * Provides a bash script to aid in the conversion process * Includes the initial legal docs required for the VPN services in the directory specified in the request: "/assets/legal" for review Closes #5718 2020-06-30 01:56:10 +03:00			`- pandoc: https://github.com/jgm/pandoc/blob/master/INSTALL.md`
			`- LaTeX: https://www.latex-project.org/get/`

Update legal-md-to-pdf.sh script and add resulting localized PDFs. 2021-03-09 22:36:22 +03:00			`##### To Run:`

			```bash
			`# from root fxa directory`
			`_scripts/legal-md-to-pdf.sh '/absolute/path/to/legal-docs/'`
			```

Revert Mozilla VPN legal docs file pattern 2021-03-11 05:10:24 +03:00			The script traverses the legal-docs directory looking for localized copies of the Mozilla VPN legal documents. When found, the script converts the document from .md to .pdf and writes it to `assets/legal/<document_name>.<locale>.pdf`.
Update legal-md-to-pdf.sh script and add resulting localized PDFs. 2021-03-09 22:36:22 +03:00
chore (fxa script): create script to convert legal markdown files to pdfs Because: * Creating a script to aid in the conversion of entire directories or single markdown files to pdfs will reduce the amount of time spent on markdown to pdf conversion requests. This commit: * Provides a bash script to aid in the conversion process * Includes the initial legal docs required for the VPN services in the directory specified in the request: "/assets/legal" for review Closes #5718 2020-06-30 01:56:10 +03:00			`Example:`
Update legal-md-to-pdf.sh script and add resulting localized PDFs. 2021-03-09 22:36:22 +03:00			directory provided: `/Users/test/github/mozilla/legal-docs/`
Revert Mozilla VPN legal docs file pattern 2021-03-11 05:10:24 +03:00			resulting file: `assets/legal/<document_name>.<locale>.pdf`