Open Bug 1785129 Opened 2 years ago Updated 2 years ago

Add an info box mechanism to indicate the need for data collection review ("data review") in info boxes on searchfox source listing pages

Categories

(Webtools :: Searchfox, enhancement)

enhancement

Tracking

(Not tracked)

People

(Reporter: asuth, Unassigned)

References

Details

While reviewing a change to use counters I thought it would be nice to have an explicit info box on files that are inherently used for purposes subject to data review that if you're touching them (or reviewing changes to them!) you need to make sure that the data collection review process at https://wiki.mozilla.org/index.php?title=Data_Collection is followed. https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/scalars.html is an example of an existing info box styling in the rendered documentation.

The mechanism for this that makes the most sense is building on the repo_files.py extensibility mechanism which we probably want to be expanding soon to help express what is a test file and what is not a test file instead of having hard-coded logic in router.py and now searchfox-tool's logic.

Note that this is adjacent to my proposed indexing of markdown docs in bug 1763532 but I think cross-references like https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/use-counters.html explicitly linking to https://searchfox.org/mozilla-central/source/dom/base/UseCounters.conf should not directly result in an info box, but instead populate a list of "docs that reference this file" that would live in the "super sidebar" which will be the home for extra useful info that should not be directly in people's faces.

Assignee: bugmail → nobody
Status: ASSIGNED → NEW
You need to log in before you can comment on or make changes to this bug.