1420216 - Investigate why images are not showing in Telemetry in-tree docs

Status: NEW

(Firefox Build System :: General, defect, P3)

Description

[Alessio Placitelli [:Dexter]]

An image should be showing at https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/sessions.html

However, it isn't showing up. Let's investigate why that's happening.

Comment 1

[Alessio Placitelli [:Dexter]]

Looks like the compiled docs are referencing a wrong path for the image resources. Building the documentation locally works fine and the image source is:

> ../../../../../_images/subsession_triggers.png

On firefox-source-docs, however, it's:

> toolkit/components/telemetry/telemetry/concepts/subsession_triggers.png

It's easy to verify that there's no image in the telemetry/concepts/ directory. However if we try to access

> https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/../../../../../_images/subsession_triggers.png

which resolves to:

> https://firefox-source-docs.mozilla.org/_images/subsession_triggers.png

The image is loaded, so the static file is definitely there but, for some reason, the online compiled docs are looking into the wrong place.

The code itself seems to look good:

https://dxr.mozilla.org/mozilla-central/rev/c2248f85346939d3e0b01f57276c440ccb2d16a1/toolkit/components/telemetry/docs/concepts/sessions.rst#24

Comment 2

[Alessio Placitelli [:Dexter]]

:gps, are you the right person to ask about this? Do you have any clue why the generated docs are referencing the wrong path? Please note that this was working fine on read-the-docs and is working fine with ./mach doc.

Comment 3

[Gregory Szorc [:gps]]

I'm scratching my head with this one.

https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/sessions.html is using a root relative path in the <img>. But locally the HTML has a ../.. path.

We're not touching the content as part of uploading it. So I have no clue why we're seeing relative paths in automation but not locally. Perhaps something in Sphinx land is looking at a CWD variable or something that isn't properly defined in automation? This is most wonky.

Anyway, this is almost certainly not a problem with the Telemetry docs, so moving the component.

Comment 4

[Alessio Placitelli [:Dexter]]

(In reply to Gregory Szorc [:gps] from comment #3)
> Anyway, this is almost certainly not a problem with the Telemetry docs, so
> moving the component.

Thanks Gregory, I'm untaking this then!

Comment 5

[Sylvestre Ledru [:Sylvestre]]

Moving to p3 because no activity for at least 24 weeks.