1754765 - Update Severity levels documentation in tree, or just drop it and link to https://wiki.mozilla.org/BMO/UserGuide/BugFields#severity

Status: RESOLVED FIXED

(Developer Infrastructure :: Firefox Source Docs: Content, task)

Description

[Marco Castelluccio [:marco]]

The definitions of the levels in https://wiki.mozilla.org/BMO/UserGuide/BugFields#severity has been changed, but the change was not also applied to https://firefox-source-docs.mozilla.org/bug-mgmt/guides/severity.html.

Instead of having to periodically update both, I would remove the values definition from https://firefox-source-docs.mozilla.org/bug-mgmt/guides/severity.html and just add a link to https://wiki.mozilla.org/BMO/UserGuide/BugFields#severity instead.
This still means that we have to update the examples if they are no longer relevant, but overall reduces the need for updates.

Comment 1

[David Lawrence [:dkl]]

(In reply to Marco Castelluccio [:marco] from comment #0)

The definitions of the levels in https://wiki.mozilla.org/BMO/UserGuide/BugFields#severity has been changed, but the change was not also applied to https://firefox-source-docs.mozilla.org/bug-mgmt/guides/severity.html.

Instead of having to periodically update both, I would remove the values definition from https://firefox-source-docs.mozilla.org/bug-mgmt/guides/severity.html and just add a link to https://wiki.mozilla.org/BMO/UserGuide/BugFields#severity instead.
This still means that we have to update the examples if they are no longer relevant, but overall reduces the need for updates.

That is fine but I do not have access to change https://firefox-source-docs.mozilla.org/bug-mgmt/guides/severity.html so not sure this is the right component for this bug. We can update the wiki whenever we need to and always have BMO point to it rather than keeping the definitions in the BMO code. Who can we contact about updating firefox-source-docs?

Comment 2

[Marco Castelluccio [:marco]]

These docs are defined in-tree at https://searchfox.org/mozilla-central/source/docs/bug-mgmt/guides/severity.rst.

I filed the bug in this component because of the history of https://hg.mozilla.org/mozilla-central/log/tip/docs/bug-mgmt/guides/severity.rst, where most bugs were in this component. Not sure if there is a better component now.

Comment 3

[David Lawrence [:dkl]]

(In reply to Marco Castelluccio [:marco] from comment #2)

These docs are defined in-tree at https://searchfox.org/mozilla-central/source/docs/bug-mgmt/guides/severity.rst.

I filed the bug in this component because of the history of https://hg.mozilla.org/mozilla-central/log/tip/docs/bug-mgmt/guides/severity.rst, where most bugs were in this component. Not sure if there is a better component now.

Maybe Firefox::Build Documentation or Firefox::Documentation Infrastructure. Not sure either. Just don't want this to get lost by being somewhere where people with commit rights to the tree won't see it.

Comment 4

[Marco Castelluccio [:marco]]

Attachment: Bug 1754765 - Don't enumerate severity levels in the source docs to avoid sync problems with the canonical definitions. r=sylvestre,glob

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9318a19dc6cf
Don't enumerate severity levels in the source docs to avoid sync problems with the canonical definitions. r=glob DONTBUILD

Comment 6

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/9318a19dc6cf