628fb0c211
* fix(storybook): update storybook publish links Because: * Latest versions of Storybook builds are no longer published to Github pages. This commit: * Update docs to indicate new location where Storybooks are published. Closes #11468 |
||
---|---|---|
.circleci | ||
.github | ||
.vscode | ||
.yarn | ||
_dev | ||
_scripts | ||
assets | ||
docs | ||
packages | ||
types | ||
.dockerignore | ||
.eslintignore | ||
.git-blame-ignore-revs | ||
.gitignore | ||
.nvmrc | ||
.prettierignore | ||
.yarnrc.yml | ||
AUTHORS | ||
CODEOWNERS | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
SECURITY.md | ||
package-scripts.js | ||
package.json | ||
release-feature-branch.sh | ||
release.sh | ||
yarn.lock |
README.md
Firefox Accounts
The Firefox Accounts (fxa) monorepo
Table of Contents
Getting Started
Contributing
Documentation
Documentation for Scripts
Getting Started
Please read our documentation
Contributing
See the separate CONTRIBUTING.md to learn how to contribute.
Documentation
The Firefox 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:
# 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