canonical/sphinx-stack

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

Offen

#512 geöffnet am 28.01.2026

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen) (76 Forks)auto 404
good first issueimprovement

Repository-Metriken

Stars
 (34 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Suchen Sie ein vorhandenes Bild im Repository oder fügen Sie ein neues hinzu, und aktualisieren Sie dann den ogp image Pfad in conf.py. Überprüfen Sie, ob der Build korrekt ist.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90