voxel51/fiftyone

[DOCS] Configure page metadata for better social media sharing experience

Open

#1960 aperta il 19 lug 2022

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (400 fork)batch import
documentationgood first issue

Metriche repository

Star
 (4021 star)
Metriche merge PR
 (Merge medio 3g 11h) (161 PR mergiate in 30 g)

Descrizione

We should optimize the docs pages so that the relevant metadata (title, thumbnail, etc) are more appropriate for sharing on social media.

Suggestions:

  • Add og:image on docs URLs so they unfurl on social media
  • Add other metadata such as title and description, too

For example, here's how adding https://voxel51.com/docs/fiftyone/tutorials/index.html to social media posts presents right now:

Twitter

Currently pulls no image at all...

LinkedIn

Currently pulls the first image from the page itself:

Facebook

Pulls a logo image (awful):

Guida contributor

Direzione di ricerca
Trova il template della pagina della documentazione (ad esempio in un layout Sphinx o MkDocs) e aggiungi i meta tag og:image, title e description. Assicurati che l'URL dell'immagine sia assoluto e che titolo/descrizione siano impostati dinamicamente per ogni pagina.
Tech stack
Nessuno
Dominio
documentationweb dev
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
HTMLmeta tags
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90