From 9455a91500edd4518c28c60aa7e33aea918c2ee4 Mon Sep 17 00:00:00 2001 From: chocos Date: Tue, 30 Jun 2020 22:26:40 +0000 Subject: [PATCH] Bug 1648959 - Done internal linking in docs in toolkit Directory,DONTBUILD.r=championshuttler Differential Revision: https://phabricator.services.mozilla.com/D81464 --- toolkit/components/normandy/docs/data-collection.rst | 7 ++----- .../telemetry/docs/collection/histograms.rst | 2 ++ .../components/telemetry/docs/collection/scalars.rst | 7 ++++++- toolkit/components/telemetry/docs/internals/review.rst | 2 +- .../docs/start/report-gecko-telemetry-in-glean.rst | 10 +++++----- 5 files changed, 16 insertions(+), 12 deletions(-) diff --git a/toolkit/components/normandy/docs/data-collection.rst b/toolkit/components/normandy/docs/data-collection.rst index ad41331ce20e..75a48a2ba498 100644 --- a/toolkit/components/normandy/docs/data-collection.rst +++ b/toolkit/components/normandy/docs/data-collection.rst @@ -122,21 +122,18 @@ reported under the key ``normandy/recipe/``: Normandy failed to verify the signature of the recipe. -Additionally, Normandy reports a `keyed scalar`_ to measure recipe +Additionally, Normandy reports a :ref:`keyed scalar ` to measure recipe freshness. This scalar is called ``normandy.recipe_freshness``, and it corresponds to the ``last_modified`` date of each recipe (using its ID as the key), reported as seconds since 1970 in UTC. -.. _keyed scalar: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html - Enrollment ----------- Normandy records enrollment and unenrollment of users into studies, and -records that data using `Telemetry Events`_. All data is stored in the +records that data using :ref:`Telemetry Events `. All data is stored in the ``normandy`` category. -.. _Telemetry Events: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html Enrollment IDs ^^^^^^^^^^^^^^ diff --git a/toolkit/components/telemetry/docs/collection/histograms.rst b/toolkit/components/telemetry/docs/collection/histograms.rst index e2f75c5b9649..ca1bf763340a 100644 --- a/toolkit/components/telemetry/docs/collection/histograms.rst +++ b/toolkit/components/telemetry/docs/collection/histograms.rst @@ -230,6 +230,8 @@ Optional. This is one of: Every new or changed data collection in Firefox needs a `data collection review `__ from a Data Steward. +.. _histogram-products: + ``products`` ------------- Required. This field is a list of products this histogram can be recorded on. Currently-supported values are: diff --git a/toolkit/components/telemetry/docs/collection/scalars.rst b/toolkit/components/telemetry/docs/collection/scalars.rst index b7d503fa8764..a36f6744141f 100644 --- a/toolkit/components/telemetry/docs/collection/scalars.rst +++ b/toolkit/components/telemetry/docs/collection/scalars.rst @@ -84,6 +84,9 @@ Example: // Now scalars can be recorded. Services.telemetry.scalarSet("myAddon.category.counter_scalar", 37); + +.. _scalars-c++-API: + C++ API ------- Probes in native code can use the more convenient helper functions declared in `Telemetry.h `_: @@ -151,6 +154,8 @@ A probe can be defined as follows: notification_emails: - telemetry-client-dev@mozilla.com +.. _scalars-required-fields: + Required Fields --------------- @@ -193,7 +198,7 @@ String type restrictions To prevent abuses, the content of a string scalar is limited to 50 characters in length. Trying to set a longer string will result in an error and no string being set. -.. _scalars.keyed-scalars: +.. _scalars-keyed-scalars: Keyed Scalars ------------- diff --git a/toolkit/components/telemetry/docs/internals/review.rst b/toolkit/components/telemetry/docs/internals/review.rst index 9420c7cd3a2a..9c604ec3a84b 100644 --- a/toolkit/components/telemetry/docs/internals/review.rst +++ b/toolkit/components/telemetry/docs/internals/review.rst @@ -80,7 +80,7 @@ Considerations for all changes - Does this need documentation updates? - - To the `in-tree docs `_? + - To the :ref:`in-tree docs `? - To the `firefox-data-docs `_ (`repository `_)? - To the `glean documentation `_? diff --git a/toolkit/components/telemetry/docs/start/report-gecko-telemetry-in-glean.rst b/toolkit/components/telemetry/docs/start/report-gecko-telemetry-in-glean.rst index 9a794c0a86bd..feb2cadbf0d8 100644 --- a/toolkit/components/telemetry/docs/start/report-gecko-telemetry-in-glean.rst +++ b/toolkit/components/telemetry/docs/start/report-gecko-telemetry-in-glean.rst @@ -24,7 +24,7 @@ Exfiltrating existing histograms is a relatively straightforward process made up Tag histograms in ``Histograms.json`` ------------------------------------- Accumulations to non-tagged histograms are ignored if streaming Telemetry is enabled. -To tag a histogram you must add the `geckoview_streaming` product to the `products list `__ in the `Histograms.json file `__ . +To tag a histogram you must add the `geckoview_streaming` product to the :ref:`products list ` in the `Histograms.json file `__ . Add Glean metrics to ``metrics.yaml`` ------------------------------------- @@ -161,7 +161,7 @@ Exfiltrating existing boolean, string or uint scalars, or adding new ones, is a Tag scalars in ``Scalars.yaml`` ---------------------------------- Accumulations to non-tagged scalars are ignored if streaming Telemetry is enabled. -To tag a scalar you must add the `geckoview_streaming` product to the `products list `__ in the `Scalars.yaml file `__ . +To tag a scalar you must add the `geckoview_streaming` product to the :ref:`products list ` in the `Scalars.yaml file `__ . Add Glean metrics to ``metrics.yaml`` ------------------------------------- @@ -254,6 +254,6 @@ Unsupported features ==================== This is the list of the currently unsupported features: -* `keyed scalars `__ are not supported and there are no future plans for supporting them; -* uint scalar operations other than `set `__ are not supported and there are no future plans for supporting them. -* `events `__ are not supported and there are no future plans for supporting them. +* :ref:`keyed scalars ` are not supported and there are no future plans for supporting them; +* uint scalar operations other than :ref:`set ` are not supported and there are no future plans for supporting them. +* :ref:`events ` are not supported and there are no future plans for supporting them.