Bug 1821392 Comment 0 Edit History

Note: The actual edited comment in the bug view page will always show the original commenter’s name and original timestamp.

Currently it is not possible in the search & address bar telemetry docs to directly link to specific telemetry probes. We should change the probe titles to use headers.

These are the files affected:

* [Address Bar](https://searchfox.org/mozilla-central/source/browser/components/urlbar/docs/telemetry.rst)
* [Search (browser part)](https://searchfox.org/mozilla-central/source/browser/components/search/docs/telemetry.rst)
* [Search (toolkit part)](https://searchfox.org/mozilla-central/source/toolkit/components/search/docs/Telemetry.rst)

For each of the probes listed, we should change them to use titles, similar to [what has been done here](https://searchfox.org/mozilla-central/rev/cd2121e7d83af1b421c95e8c923db70e692dab5f/browser/components/urlbar/docs/firefox-suggest-telemetry.rst#23-24,37-38,51-52).

Changes can be tested with `./mach doc`, which after a while will open a browser with the updated docs. Changes can also be made whilst that is still running, and it will rebuild the pages.

Additionally, changes should be linted with `./mach lint path/to/file` and ensure there are no errors.
Currently it is not possible in the search & address bar telemetry docs to directly link to specific telemetry probes. We should change the probe titles to use headers.

These are the files affected:

* [Address Bar](https://searchfox.org/mozilla-central/source/browser/components/urlbar/docs/telemetry.rst)
* [Search (browser part)](https://searchfox.org/mozilla-central/source/browser/components/search/docs/telemetry.rst)
* [Search (toolkit part)](https://searchfox.org/mozilla-central/source/toolkit/components/search/docs/Telemetry.rst)

For each of the probes listed, we should change them to use titles (add `~~~~` under titles), similar to [what has been done here](https://searchfox.org/mozilla-central/rev/cd2121e7d83af1b421c95e8c923db70e692dab5f/browser/components/urlbar/docs/firefox-suggest-telemetry.rst#23-24,37-38,51-52).

Changes can be tested with `./mach doc`, which after a while will open a browser with the updated docs. Changes can also be made whilst that is still running, and it will rebuild the pages.

Additionally, changes should be linted with `./mach lint path/to/file` and ensure there are no errors.

Back to Bug 1821392 Comment 0