canonical/sphinx-stack

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

Aberta

#512 aberto em 28 de jan. de 2026

Ver no GitHubGuia do colaborador
 (0 comentário) (1 reação) (0 responsável) (76 forks)auto 404
good first issueimprovement

Métricas do repositório

Stars
 (34 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Localize uma imagem existente no repositório ou adicione uma nova e atualize o caminho ogp image no conf.py. Verifique se a compilação está correta.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90