Template for Metric Detail pages

[GeorgLink]

In response to the phone call today, here is a draft for a template for a "Metric Detail" page.

• Are the sections clear?
• Do we need more sections?

[abuhman]

Looks good to me.

[germonprez]

Me too

[bkeepers]

Looks good! I hadn't poked around the wiki yet, so it's cool to see how much progress has been made in documenting everything in the last couple weeks.

[GeorgLink]

Thanks @bkeepers !

---

@howderek you have worked with the metrics quite a bit and voiced the idea for the "Metric Detail" pages. Can you comment on the template?

---

Does anyone have thoughts on the idea to remove the columns Source and Code/Queries from the metrics table and maintain that information only in the "Metric Detail" pages. The table would be cleaner and only be an overview and entry point for details.

[GeorgLink]

@abuhman @howderek where are you with the data exchange format for exchanging metrics?

Would it make sense to extend the "Metric Detail" page by a section "Data Exchange Format" or something where we specify how the metric will be encoded in JSON or whichever data exchange format will be used?
This could standardize implementations for the metrics and foster interoperability.

The idea is from the SPDX specification.

[howderek]

@GeorgLink I don't think the "queries/code" is necessary since we have the known implementations section that will link to code. If we are to use that section for pseudocode, I think that should be explicitly the title of that section.

Including static visualizations of each metric might help users get a feel for them.

It looks great overall!

Regarding the "Source and Code/Queries "column: I agree it should be removed from the table you mentioned.

Regarding the "data exchange format", I've implemented API documentation which @sgoggins has asked me to make some changes to. I'll work on that soon. Please let me know if there is a format you would prefer.

[GeorgLink]

I don't think the "queries/code" is necessary since we have the known implementations section that will link to code. If we are to use that section for pseudocode, I think that should be explicitly the title of that section.

Good point. I changed the section heading.

Including static visualizations of each metric might help users get a feel for them.

Great idea, I added a sub-section under "4. Description" and subsumed "Interpretation" there as well.

Regarding the "data exchange format", I've implemented (API documentation)[ https://osshealth.github.io/ghdata/api/index.html] which @sgoggins <https://github.com/sgoggins> has asked me to make some changes to. I'll work on that soon.

That would be a great place to link to, then you don't have to maintain two places.