1624870 - [docs] instructions for version editing and product support needs work

Status: RESOLVED FIXED

(Socorro :: General, task, P2)

Description

[Will Kahn-Greene [:willkg] ET needinfo? me]

Socorro supports multiple products. In order for that to work, crash reports from those products need certain things.

There's some documentation at:

https://crash-stats.mozilla.org/documentation/products/

This needs to be updated to include details about how Version affects the site. Further, it's really hard to read that page and maybe we should move it to the Socorro RTD docs.

For editing versions, there's some documentation at:

https://github.com/mozilla-services/socorro/tree/master/product_details

There's a tiny note on the product home page that links to this page, but the link is too far from the left side and "Note:" isn't enough of an indicator to get people to read the line.

Further, there's nothing in the product support docs about versions and how to edit them.

This bug covers cleaning this all up.

Comment 1

[Will Kahn-Greene [:willkg] ET needinfo? me]

I really need a place I can point people to for product support related things, so making this better is important.

Making this a P2 and grabbing this to work on.

Comment 2

[Will Kahn-Greene [:willkg] ET needinfo? me]

Attachment: pr 5300: bug 1624870: improve product support docs and tips

Comment 3

[Will Kahn-Greene [:willkg] ET needinfo? me]

willkg merged PR #5300: "bug 1624870: improve product support docs and tips" in 26a041c.

Comment 4

[Will Kahn-Greene [:willkg] ET needinfo? me]

I deployed this to prod just now in bug #1626677.