opengraph improvements

[edublancas]

to improve SEO, we recently added html_meta to the sections in our docs. example

However, we are not displaying any images.

The other weird thing is that it says "Python documentation" instead of "JupySQL documentation"

There are a few things to do here:

• investigate how to modify the Python documentation so it shows JupySQL documentation
• investigate how to display an image (most likely, we need to modify the html_meta)
• check if it's possible to display one image by default (so we are not missing anything, we can later customize them)
• create a sample image, you can use this template - note that this requires the draw.io app
• add it to a sample article, let's start with duckdb's one

[edublancas]

note: we use jupyter-book so we might wanna check out their docs

[lfunderburk]

Thank you Eduardo
Taking a peek

[lfunderburk]

Hello @edublancas

Tackled the following items:

1. investigate how to display an image (most likely, we need to modify the html_meta)
2. check if it's possible to display one image by default (so we are not missing anything, we can later customize them)
3. create a sample image, you can use this
4. add it to a sample article, let's start with duckdb's one

Solutions explored:

Added a property=og:image: option to the html_meta

myst:
  html_meta:
    description lang=en: Use DuckDB from Jupyter using JupySQL
    keywords: jupyter, sql, jupysql, duckdb, plotting
    property=og:locale: en_US
    property=og:image: ./img/html-meta-template.png

Created a template in both .drawio and .jpeg formats and added it to the DuckDB tutorial. PR here #398

[lfunderburk]

For this item

investigate how to modify the Python documentation so it shows JupySQL documentation

I am not sure what you mean as I couldn't find in the rendered doc the phrase "Python documentation". Do you mean find a way to link our docs with the official Python docs? or did you mean something else?

[edublancas]

I am not sure what you mean as I couldn't find in the rendered doc the phrase "Python documentation". Do you mean find a way to link our docs with the official Python docs? or did you mean something else?

The title in the browser tab says: {section name} - Python documentation

[edublancas]

@lfunderburk: I assigned this to @anupam-tiwari

@anupam-tiwari: please go over the existing issue to get the context, there is also a related (unfinished PR): #398

[sync-by-unito]

➤ Anupam Tiwari commented:

On it!

[edublancas]

any updates here? @anupam-tiwari

[anupam-tiwari]

Apologies for missing this one. I'm working on it right now!

[edublancas]

great!