Closed Bug 1672716 Opened 4 years ago Closed 4 years ago

Figure out how to tell sphinx about metric definition files that are not called `metrics.yaml`

Categories

(Toolkit :: Telemetry, enhancement)

enhancement

Tracking

()

RESOLVED WONTFIX

People

(Reporter: janerik, Unassigned)

References

Details

Right now we glob-pattern all metrics.yaml files, but not files that are named differently.

Pattern in build/sparse-profiles/sphinx-docs
We either need to document this or make it easier to use another name for the file.

After giving this some thought, I think having a strict requirement on the name of the file will help people find them in the tree. I'm for WONTFIXing this since we're clear in the docs that it should be named metrics.yaml or pings.yaml

What do you think, Jan-Erik?

Flags: needinfo?(jrediger)

Works for me!

Status: NEW → RESOLVED
Closed: 4 years ago
Flags: needinfo?(jrediger)
Resolution: --- → WONTFIX

FWIW, I had no idea that all these files were supposed to be named {metrics,pings}.yaml and this just got me backed out in https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c20. Glean has a punishing linter; let's add this to it.

Blocks: 1705403
You need to log in before you can comment on or make changes to this bug.