canonical/sphinx-stack

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

Open

#512 opened on Jan 28, 2026

View on GitHubContributor guide
 (0 comments) (1 reaction) (0 assignees) (76 forks)auto 404
good first issueimprovement

Repository metrics

Stars
 (34 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Locate an existing image in the repository or add a new one, then update the ogp image path in conf.py. Verify the change builds correctly.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90