canonical/sphinx-stack

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

Ouverte

#512 ouverte le 28 janv. 2026

Voir sur GitHubGuide contributeur
 (0 commentaire) (1 réaction) (0 personne assignée) (76 forks)auto 404
good first issueimprovement

Métriques du dépôt

Stars
 (34 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Localisez une image existante dans le dépôt ou ajoutez en une nouvelle, puis mettez à jour le chemin ogp image dans conf.py. Vérifiez que la construction est correcte.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90