Cosa rende un sito compatibile con le anteprime di onebox?

Supporto
1

Vorrei aiutare gli sviluppatori del seguente framework Python a renderlo compatibile con Onebox per la nostra istanza Discourse, al fine di promuoverlo:

https://docs.sunpy.org/en/v3.0.0/whatsnew/3.0.html

Allora, cosa rende un sito compatibile con Onebox? Ho cercato “onebox” su Google e sono arrivato a questa pagina GitHub: GitHub - discourse/onebox: (DEPRECATED) A gem for turning URLs into website previews · GitHub. Per il framework che ho menzionato, gli sviluppatori usano Sphinx per generare automaticamente alcune pagine; esiste qualche impostazione che gli sviluppatori possono configurare in Sphinx per rendere le loro pagine compatibili con Onebox?

2

Se provi a inserire https://docs.sunpy.org/en/v3.0.0/whatsnew/3.0.html in una riga da sola, vedrai questo messaggio:

Ci dispiace, non siamo riusciti a generare un’anteprima per questa pagina web, perché non sono stati trovati i seguenti tag oEmbed / OpenGraph: description, image

Quella pagina ha un tag meta OpenGraph description vuoto, quindi non possiamo incorporarla. Utilizza inoltre URL relativi per alcuni altri tag OpenGraph, come image e url, di cui non sono sicuro che siano supportati.

3

Quindi ho inoltrato le informazioni al team di sviluppo di SunPy. Hanno testato una correzione con questa pagina: https://sunpy--5366.org.readthedocs.build/en/5366/, ed è stata validata da opengraph.xyz, che ha confermato che tutti i tag sono definiti nel file HTML:

<!-- HTML Meta Tags -->
<title>SunPy Documentation</title>
<meta name="description" content="SunPy Documentation">

<!-- Facebook Meta Tags -->
<meta property="og:description" content="SunPy Documentation">
<meta property="og:image" content="https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpy_logo_word.png" />
<meta property="og:site_name" content="SunPy Documentation" />
<meta property="og:title" content="SunPy Documentation">
<meta property="og:type" content="website">
<meta property="og:url" content="https://docs.sunpy.org/en/stable//index.html" />

<!-- Twitter Meta Tags -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:description" content="SunPy Documentation">
<meta name="twitter:image" content="https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpy_logo_word.png">
<meta name="twitter:title" content="SunPy Documentation">
<meta property="twitter:domain" content="https://docs.sunpy.org/en/stable/">
<meta property="twitter:url" content="https://docs.sunpy.org/en/stable//index.html">

Tuttavia, nel nostro istanza di Discourse continua a non funzionare e otteniamo ancora l’errore: oEmbed / OpenGraph tags could not be found:description, image

C’è qualcosa che non stanno vedendo? Ecco la nostra discussione su GitHub riguardo a questo problema: onebox-compatible documentation for promoting SunPy's features and updates · Issue #5362 · sunpy/sunpy · GitHub

4

È una voce reale? La descrizione dovrebbe essere più lunga e contenere un sottoinsieme del contenuto effettivo della pagina, non un segnaposto come “Documentazione SunPy”.

5

La descrizione viene ignorata perché è identica al titolo. Dovresti estrarre le parti più rilevanti del contenuto e inserirle nella proprietà descrizione.