Bug 1938452 - Move newtab documentation to browser/extensions/newtab. r=omc-reviewers,firefox-desktop-core-reviewers ,home-newtab-reviewers,pdahiya,mossop,amy
Differential Revision: https://phabricator.services.mozilla.com/D233866
This commit is contained in:
@@ -5644,7 +5644,7 @@ export var DefaultBrowserCheck = {
|
||||
* performance optimization. It only works when the "privileged about
|
||||
* content process" is enabled and when ENABLED_PREF is set to true.
|
||||
*
|
||||
* See https://firefox-source-docs.mozilla.org/browser/components/newtab/docs/v2-system-addon/about_home_startup_cache.html
|
||||
* See https://firefox-source-docs.mozilla.org/browser/extensions/newtab/docs/v2-system-addon/about_home_startup_cache.html
|
||||
* for further details.
|
||||
*/
|
||||
export var AboutHomeStartupCache = {
|
||||
|
||||
@@ -83,7 +83,7 @@ export class AboutWelcomeTelemetry {
|
||||
* there is a case where spotlight may use this, too)
|
||||
* containing a nested structure of data for reporting as
|
||||
* telemetry, as documented in
|
||||
* https://firefox-source-docs.mozilla.org/browser/components/newtab/docs/v2-system-addon/data_events.html
|
||||
* https://firefox-source-docs.mozilla.org/browser/extensions/newtab/docs/v2-system-addon/data_events.html
|
||||
* Does not have all of its data (`_createPing` will augment
|
||||
* with ids and attribution if available).
|
||||
*/
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# Messaging System & Onboarding Telemetry
|
||||
|
||||
This document (combined with the [messaging system ping section of the Glean Dictionary](https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/pings/messaging-system)), is now the place to look first for Messaging System and Onboarding telemetry information. For historical reasons, there is still some related documentation mixed in with the Activity Stream documentation. If you can't find what you need here, check [old metrics we collect](/browser/components/newtab/docs/v2-system-addon/data_events.md) and the
|
||||
[old data dictionary](/browser/components/newtab/docs/v2-system-addon/data_dictionary.md).
|
||||
This document (combined with the [messaging system ping section of the Glean Dictionary](https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/pings/messaging-system)), is now the place to look first for Messaging System and Onboarding telemetry information. For historical reasons, there is still some related documentation mixed in with the Activity Stream documentation.
|
||||
|
||||
## Collection with Glean
|
||||
|
||||
@@ -32,7 +31,7 @@ file.
|
||||
## Adding or changing telemetry
|
||||
|
||||
A general process overview can be found in the
|
||||
[Activity Stream telemetry document](/browser/components/newtab/docs/v2-system-addon/telemetry.md).
|
||||
[Activity Stream telemetry document](/browser/extensions/newtab/docs/v2-system-addon/telemetry.md).
|
||||
|
||||
Note that when you need to add new metrics (i.e. JSON keys),
|
||||
they MUST to be
|
||||
|
||||
@@ -65,7 +65,7 @@ const PREF_ACTIVITY_STREAM_DEBUG = "browser.newtabpage.activity-stream.debug";
|
||||
* process" first launches, so subsequent loads of about:home do not read
|
||||
* from this cache.
|
||||
*
|
||||
* See https://firefox-source-docs.mozilla.org/browser/components/newtab/docs/v2-system-addon/about_home_startup_cache.html
|
||||
* See https://firefox-source-docs.mozilla.org/browser/extensions/newtab/docs/v2-system-addon/about_home_startup_cache.html
|
||||
* for further details.
|
||||
*/
|
||||
export const AboutHomeStartupCacheChild = {
|
||||
|
||||
@@ -12,8 +12,6 @@ BROWSER_CHROME_MANIFESTS += [
|
||||
"test/browser/browser.toml",
|
||||
]
|
||||
|
||||
SPHINX_TREES["docs"] = "docs"
|
||||
|
||||
XPCSHELL_TESTS_MANIFESTS += [
|
||||
"test/xpcshell/xpcshell.toml",
|
||||
]
|
||||
|
||||
@@ -14,7 +14,7 @@ This is the nascent documentation of the Firefox front-end code.
|
||||
components/customizableui/docs/index
|
||||
components/enterprisepolicies/docs/index
|
||||
extensions/formautofill/docs/index
|
||||
components/newtab/docs/index
|
||||
extensions/newtab/docs/index
|
||||
components/aboutwelcome/docs/index
|
||||
installer/windows/installer/index
|
||||
components/attribution/docs/index
|
||||
|
||||
@@ -6,3 +6,5 @@
|
||||
|
||||
with Files("**"):
|
||||
BUG_COMPONENT = ("Firefox", "New Tab Page")
|
||||
|
||||
SPHINX_TREES["docs"] = "docs"
|
||||
|
||||
@@ -96,7 +96,6 @@ categories:
|
||||
|
||||
redirects:
|
||||
browser/browser: browser
|
||||
browser/components/newtab/content-src/asrouter/docs: browser/components/newtab/docs
|
||||
contributing/how_to_contribute_firefox.html: contributing/contribution_quickref.html
|
||||
contributing/artifact_builds.html: contributing/build/artifact_builds.html
|
||||
contributing/linux_build.html: setup/linux_build.html
|
||||
|
||||
@@ -65,7 +65,7 @@ Testing
|
||||
* `marionette`_
|
||||
|
||||
.. _xpcshell: /testing/xpcshell/index.html
|
||||
.. _mochitest: /browser/components/newtab/docs/v2-system-addon/mochitests.html
|
||||
.. _mochitest: /testing/mochitest-plain/index.html
|
||||
.. _web-platform: /web-platform/index.html
|
||||
.. _gtest: /gtest/index.html
|
||||
.. _marionette: /testing/marionette/index.html
|
||||
|
||||
@@ -5,13 +5,13 @@ codespell:
|
||||
- browser/base/content/docs/
|
||||
- browser/branding/
|
||||
- browser/components/asrouter/docs/
|
||||
- browser/components/newtab/docs/
|
||||
- browser/components/places/docs/
|
||||
- browser/components/search/docs/
|
||||
- browser/components/search/schema/
|
||||
- browser/components/touchbar/docs/
|
||||
- browser/components/urlbar/docs/
|
||||
- browser/extensions/formautofill/locales/en-US/
|
||||
- browser/extensions/newtab/docs/
|
||||
- browser/extensions/report-site-issue/locales/en-US/
|
||||
- browser/installer/windows/docs/
|
||||
- browser/locales/en-US/
|
||||
|
||||
Reference in New Issue
Block a user