Remote Assets of Firefox Messaging System
Перейти к файлу
negin f67273664d adds moments page 19 2024-10-21 11:47:43 -04:00
.circleci Ensure schemas are kept up to date with CircleCI 2022-08-04 00:56:51 -04:00
archive Issue #245 - Archive moments page 2023-11-01 14:58:40 -07:00
messages adds moments page 19 2024-10-21 11:47:43 -04:00
outgoing adds moments page 19 2024-10-21 11:47:43 -04:00
schema Add micro-surveys message group 2023-10-11 14:23:25 -07:00
scripts Update the export script to export an ESM rather than a JSM 2023-10-18 12:19:46 -04:00
.gitignore Add a script to export messages to mozilla-central 2022-12-14 20:47:43 -05:00
.yamllint Add yamllint rules 2020-03-31 15:08:29 +02:00
CODE_OF_CONDUCT.md Add license and cod 2020-04-28 16:02:48 -04:00
LICENSE Add license and cod 2020-04-28 16:02:48 -04:00
Makefile Add a script to export messages to mozilla-central 2022-12-14 20:47:43 -05:00
README.md Update README (#61) 2020-05-07 11:05:05 -04:00
requirements.txt Add a script to fetch schemas from mozilla-central 2022-08-04 00:56:51 -04:00

README.md

Mozilla

This repo hosts various in-flight remote assets of Firefox Messaging System.

Currently, it consists of CFR, CFR-FXA, and What's New Pannel.

Usage

To add/modify/delete assets, please edit the YAML files other than the JSON ones, because the former allows us to use comments in the document. Once you complete the editing, you can sync your changes to the JSON file(s), and copy them over to Remote Settings for publishing.

When deleting asset(s), make sure copy the deleted content in the YAML files to the corresponding archive file located in the archive directory. For instance, when you're deleting messages in cfr.yaml, please copy the deletions to the archive/cfr-archived.yaml.

To sync from YAML to JSON, just run

$ make

To validate the JSON against the schema

$ make check

It requires Python 3 and various libraries for the schema validation and file generation.

# if you don't have Python 3 installed
$ brew install python3
$ pip3 install -r requirements.txt

Note: make sure you commit all the changes (YAML&JSON) to the repo.