Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Commit beb7ea0

Browse files
committed
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
1 parent 0973db9 commit beb7ea0

File tree

19 files changed

+10
-12
lines changed

19 files changed

+10
-12
lines changed

browser/components/BrowserGlue.sys.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5644,7 +5644,7 @@ export var DefaultBrowserCheck = {
56445644
* performance optimization. It only works when the "privileged about
56455645
* content process" is enabled and when ENABLED_PREF is set to true.
56465646
*
5647-
* See https://firefox-source-docs.mozilla.org/browser/components/newtab/docs/v2-system-addon/about_home_startup_cache.html
5647+
* See https://firefox-source-docs.mozilla.org/browser/extensions/newtab/docs/v2-system-addon/about_home_startup_cache.html
56485648
* for further details.
56495649
*/
56505650
export var AboutHomeStartupCache = {

browser/components/aboutwelcome/modules/AboutWelcomeTelemetry.sys.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export class AboutWelcomeTelemetry {
8383
* there is a case where spotlight may use this, too)
8484
* containing a nested structure of data for reporting as
8585
* telemetry, as documented in
86-
* https://firefox-source-docs.mozilla.org/browser/components/newtab/docs/v2-system-addon/data_events.html
86+
* https://firefox-source-docs.mozilla.org/browser/extensions/newtab/docs/v2-system-addon/data_events.html
8787
* Does not have all of its data (`_createPing` will augment
8888
* with ids and attribution if available).
8989
*/

browser/components/asrouter/docs/telemetry.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Messaging System & Onboarding Telemetry
22

3-
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
4-
[old data dictionary](/browser/components/newtab/docs/v2-system-addon/data_dictionary.md).
3+
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.
54

65
## Collection with Glean
76

@@ -32,7 +31,7 @@ file.
3231
## Adding or changing telemetry
3332

3433
A general process overview can be found in the
35-
[Activity Stream telemetry document](/browser/components/newtab/docs/v2-system-addon/telemetry.md).
34+
[Activity Stream telemetry document](/browser/extensions/newtab/docs/v2-system-addon/telemetry.md).
3635

3736
Note that when you need to add new metrics (i.e. JSON keys),
3837
they MUST to be

browser/components/newtab/AboutNewTabService.sys.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ const PREF_ACTIVITY_STREAM_DEBUG = "browser.newtabpage.activity-stream.debug";
6565
* process" first launches, so subsequent loads of about:home do not read
6666
* from this cache.
6767
*
68-
* See https://firefox-source-docs.mozilla.org/browser/components/newtab/docs/v2-system-addon/about_home_startup_cache.html
68+
* See https://firefox-source-docs.mozilla.org/browser/extensions/newtab/docs/v2-system-addon/about_home_startup_cache.html
6969
* for further details.
7070
*/
7171
export const AboutHomeStartupCacheChild = {

browser/components/newtab/moz.build

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ BROWSER_CHROME_MANIFESTS += [
1212
"test/browser/browser.toml",
1313
]
1414

15-
SPHINX_TREES["docs"] = "docs"
16-
1715
XPCSHELL_TESTS_MANIFESTS += [
1816
"test/xpcshell/xpcshell.toml",
1917
]

browser/docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This is the nascent documentation of the Firefox front-end code.
1414
components/customizableui/docs/index
1515
components/enterprisepolicies/docs/index
1616
extensions/formautofill/docs/index
17-
components/newtab/docs/index
17+
extensions/newtab/docs/index
1818
components/aboutwelcome/docs/index
1919
installer/windows/installer/index
2020
components/attribution/docs/index
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)