Me gustaría ayudar a los desarrolladores del siguiente framework de Python a que sean compatibles con Onebox en nuestra instancia de Discourse para promocionarlo:
¿Qué hace que un sitio sea compatible con Onebox? Busqué “onebox” en Google y llegué a esta página de GitHub: GitHub - discourse/onebox: (DEPRECATED) A gem for turning URLs into website previews · GitHub. Sin embargo, para el framework que mencioné, utilizan Sphinx para generar automáticamente algunas de las páginas. ¿Existe alguna configuración que los desarrolladores puedan establecer en Sphinx para que sus páginas sean compatibles con Onebox?
Si intentas enlazar https://docs.sunpy.org/en/v3.0.0/whatsnew/3.0.html en una línea por sí sola, verás este mensaje:
Lo sentimos, no pudimos generar una vista previa de esta página web, ya que no se pudieron encontrar las siguientes etiquetas oEmbed / OpenGraph: description, image
Esa página tiene una etiqueta meta OpenGraph description vacía, por lo que no podemos incrustarla. Además, utiliza URLs relativas para otras etiquetas OpenGraph, como image y url, y no estoy seguro de que eso sea compatible.
Así que reenvié la información al equipo de desarrollo de SunPy. Ellos probaron una corrección con esta página: https://sunpy--5366.org.readthedocs.build/en/5366/, y fue validada por opengraph.xyz, indicando que todas las etiquetas están definidas en el archivo HTML:
<!-- HTML Meta Tags -->
<title>Documentación de SunPy</title>
<meta name="description" content="Documentación de SunPy">
<!-- Facebook Meta Tags -->
<meta property="og:description" content="Documentación de SunPy">
<meta property="og:image" content="https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpy_logo_word.png" />
<meta property="og:site_name" content="Documentación de SunPy" />
<meta property="og:title" content="Documentación de SunPy">
<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="Documentación de SunPy">
<meta name="twitter:image" content="https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpy_logo_word.png">
<meta name="twitter:title" content="Documentación de SunPy">
<meta property="twitter:domain" content="https://docs.sunpy.org/en/stable/">
<meta property="twitter:url" content="https://docs.sunpy.org/en/stable//index.html">
No obstante, aún no funciona en nuestra instancia de Discourse; seguimos recibiendo el error: No se pudieron encontrar las etiquetas oEmbed / OpenGraph: description, image.
¿Es esa una entrada real? La descripción debería ser más larga y contener un subconjunto del contenido real de la página, no un marcador de posición como “Documentación de SunPy”.