From 55f00515e52531fbc775a2162ea75805fd210844 Mon Sep 17 00:00:00 2001 From: Ed Lee Date: Wed, 30 Jan 2019 09:57:58 -0800 Subject: [PATCH] Port Bug 1523092 - Enable codespell on more directories r=ahal (#4748) --- docs/v2-system-addon/snippets.md | 2 +- docs/v2-system-addon/telemetry.md | 2 +- docs/v2-system-addon/tippytop.md | 6 +++--- docs/v2-system-addon/unit_testing_guide.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/v2-system-addon/snippets.md b/docs/v2-system-addon/snippets.md index 2c7c75bd0..a6dff8dea 100644 --- a/docs/v2-system-addon/snippets.md +++ b/docs/v2-system-addon/snippets.md @@ -45,7 +45,7 @@ bookmarks a user has (including default bookmarks). Note that is value is only u a user restarts the browser. `.getAddonsInfo()`:( func) An async function that resolves with an object `{isFullData: (bool), addons: (obj)}`. -Note that at startup, we are sometimes unable to provide full data due to performance constraits (`.isFullData` will be `false`). +Note that at startup, we are sometimes unable to provide full data due to performance constraints (`.isFullData` will be `false`). E.g. ```js diff --git a/docs/v2-system-addon/telemetry.md b/docs/v2-system-addon/telemetry.md index 4f996c149..205feb424 100644 --- a/docs/v2-system-addon/telemetry.md +++ b/docs/v2-system-addon/telemetry.md @@ -12,7 +12,7 @@ Adding telemetry generally involves a few steps: 1. - [ ] Update [data_events.md](data_events.md) with an example of the data in question 1. - [ ] Update any fields that you've added, deleted, or changed in [data_dictionary.md](data_dictionary.md) 1. - [ ] Get review from Nan (@ncloudioj) and/or Marina (@emtwo) on the data schema and the documentation changes. -1. - [ ] Request `data-review` of your documentation changes from a [data steward](https://wiki.mozilla.org/Firefox/Data_Collection) to ensure suitability for collection controlled by the opt-out `datareporting.healthreport.uploadEnabled` pref. Download and fill out the [data review request form](https://github.com/mozilla/data-review/blob/master/request.md) and then attach it as a text file on Bugzilla so you can r? a data steward. We've been working with François Marier (:francois / @fmarier), so he's a good candidate as he's likely to have the most context. +1. - [ ] Request `data-review` of your documentation changes from a [data steward](https://wiki.mozilla.org/Firefox/Data_Collection) to ensure suitability for collection controlled by the opt-out `datareporting.healthreport.uploadEnabled` pref. Download and fill out the [data review request form](https://github.com/mozilla/data-review/blob/master/request.md) and then attach it as a text file on Bugzilla so you can r? a data steward. We've been working with Francois Marier (:francois / @fmarier), so he's a good candidate as he's likely to have the most context. 1. - [ ] Implement as usual... 1. - [ ] After landing the implementation, check with Nan (@ncloudioj) to make sure the pings are making it to the database 1. - [ ] Update the [ping-centre](https://github.com/mozilla/ping-centre/issues) user story issue for the dashboard, stating that the data should now be available for implementation, and removing any `blocked` tag if appropriate. diff --git a/docs/v2-system-addon/tippytop.md b/docs/v2-system-addon/tippytop.md index 7ba64ecee..54e123ec3 100644 --- a/docs/v2-system-addon/tippytop.md +++ b/docs/v2-system-addon/tippytop.md @@ -5,7 +5,7 @@ TippyTop, a collection of icons from the Alexa top sites, provides high quality TippyTop manifest is produced by [tippy-top-sites](https://github.com/mozilla/tippy-top-sites). ```sh -# set up the enviroment, only needed for the first time +# set up the environment, only needed for the first time $ pip install -r requirements.txt $ python make_manifest.py --count 2000 > icons.json # Alexa top 2000 sites ``` @@ -36,5 +36,5 @@ $ ./upload2remotesettings.py prod After uploading it to Remote Setting, you can request for review in the [dashboard](https://settings-writer.prod.mozaws.net/v1/admin/). Note that you will need to log in the Mozilla LDAP VPN for both uploading and accessing Remote Setting's dashboard. Once your request gets approved by the reviewer, the new manifest will be content signed and published to production. -## TippyTop Viwer -You can use this [viwer](https://mozilla.github.io/tippy-top-sites/manifest-viewer/) to load all the icons in the current manifest. +## TippyTop Viewer +You can use this [viewer](https://mozilla.github.io/tippy-top-sites/manifest-viewer/) to load all the icons in the current manifest. diff --git a/docs/v2-system-addon/unit_testing_guide.md b/docs/v2-system-addon/unit_testing_guide.md index 0ffb23ca2..50edaf323 100644 --- a/docs/v2-system-addon/unit_testing_guide.md +++ b/docs/v2-system-addon/unit_testing_guide.md @@ -17,7 +17,7 @@ run `npm run tddmc`. ## Debugging tests -To debug tests, you should run them in continous mode with `npm run tddmc`. In the +To debug tests, you should run them in continuous mode with `npm run tddmc`. In the Firefox window that is opened (it should say "Karma... - connected"), click the "debug" button and open your console to see test output, set breakpoints, etc.