canonical/sphinx-stack

Replace value of ogp_image in conf.py to an image included in the repository instead of assets manager

Aperta

#512 aperta il 28 gen 2026

Vedi su GitHubGuida contributor
 (0 commenti) (1 reazione) (0 assegnatari) (76 fork)auto 404
good first issueimprovement

Metriche repository

Star
 (34 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

In conf.py (line 87 in main branch), we have:

ogp_image = "https://assets.ubuntu.com/v1/cc828679-docs_illustration.svg"

While elsewhere, we advise not to use the asset manager for images in our RTD docs and to include the images in the GH repository instead. I find that teams using the starter pack tend to follow the example and use assets.ubuntu.com. We should show a better example by including the image file in the starter pack repository and pointing to it.

Guida contributor

Direzione di ricerca
Trova un'immagine esistente nel repository o aggiungine una nuova, quindi aggiorna il percorso ogp image in conf.py. Verifica che la build sia corretta.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90