1404684 - Glossary tooltip shows as "Editorial review completed."

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: General, enhancement)

Description

[fireattack [:fireattack]]

What did you do?
================
1. Open https://developer.mozilla.org/en-US/docs/Learn/WebGL, find "OpenGL" (in first line), and hover on it.


What happened?
==============
It shows: OpenGL: Editorial review completed. 


What should have happened?
==========================
It should show definition from https://developer.mozilla.org/en-US/docs/Glossary/OpenGL 

"OpenGL (Open Graphics Library) is a cross-language, multi-platform application programming interface (API) for rendering 2D and 3D vector graphics..."

Is there anything else we should know?
======================================
It looks like "Editorial review completed" is the last editing comment of Glossary/OpenGL: https://developer.mozilla.org/en-US/docs/Glossary/OpenGL$history

No idea why it ended up showing there, instead of actual definition.

Comment 1

[Eric Shepherd [:sheppy]]

Fixed. Thanks for reporting it!

Comment 2

[fireattack [:fireattack]]

(In reply to Eric Shepherd [:sheppy] from comment #1)
> Fixed. Thanks for reporting it!

While your editing fixed it, it doesn't explain why it shows "Editorial review completed." previously.

I also noticed that you used an explict "seoSummary" class for first <p> in OpenGL, which is not used in WebGL (https://developer.mozilla.org/en-US/docs/Glossary/WebGL$edit) but that works just fine.

I still think it's at least part of a technical issue than just documentation issue.

Comment 3

[John Whitlock [:jwhitlock]]

The issue is that the summary is either the most recent review's comment, or if that was blank, it falls back to the SEO summary:

https://github.com/mozilla/kuma/blob/de455a8ba8b4e53e608c611b3d3e064e154b5c8c/kuma/wiki/models.py#L655-L658

It has been this way for at least 4 years. It was "fixed" because Sheppy added a follow-on commit without a revision comment

https://developer.mozilla.org/en-US/docs/Glossary/OpenGL$compare?locale=en-US&to=1313069&from=924979

This smells like a bug to me, but it has been this way for years. Does anyone know if there is another part of the system that relies on this behavior?

Comment 4

[fireattack [:fireattack]]

(In reply to John Whitlock [:jwhitlock] from comment #3)

Thanks for the investigation.

As a counter-example, though: 

https://developer.mozilla.org/en-US/docs/Glossary/WebGL$history

Glossary: WebGL has a non-blank most recent editing comment, and doesn't have an SEO summary at all, but it works fine. (see first line of https://developer.mozilla.org/en-US/docs/Learn/WebGL).

Comment 5

[fireattack [:fireattack]]

Reopened for the reason mentioned above.

Comment 6

[[github robot]]

Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/562101c03952676cd41ce9a3399465b990fe1ec7
bug 1404684: Use HTML SEO summary as JSON summary

Instead of prefering the current revision's comment, always use the SEO
summary with inner HTML markup.

https://github.com/mozilla/kuma/commit/942cc393adef9885908425167c290019d084f49c
Merge pull request #4556 from jwhitlock/fix-summary-1404684

bug 1404684: Use HTML SEO summary as JSON summary

Comment 7

[Estelle Weyl]

This is the way it is supposed to work. The author of any document selects what text is the SEO summary by placing it in a span with that class. Resolving as fixed.

Comment 8

[fireattack [:fireattack]]

The bug was, last *editing comment* got used as SEO summary, which causes unwanted tooltip when hovering a glossary (readers obviously do NOT want to see editing comment when they're looking for definition of a glossary).

I'm not saying this bug still exists (so feel free to close it), but it was not "the way it is supposed to work."

Comment 9

[John Whitlock [:jwhitlock]]

Sorry for the confusion. I probably should have closed this 11 months ago. Maybe I hoped to regenerate pages in the new year to clear out any rendered pages with this bug. Or maybe December is a time for fixing things and forgetting to complete the paperwork.