voxel51/fiftyone

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

Open

#1,960 opened on Jul 19, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (400 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (4,021 stars)
PR merge metrics
 (Avg merge 3d 11h) (161 merged PRs in 30d)

Description

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):

Contributor guide

Research direction
Find the docs page template (e.g., in a Sphinx or MkDocs layout) and add og:image, title, and description meta tags. Ensure the image URL is absolute and the title/description are dynamically set for each page.
Tech stack
None
Domain
documentationweb dev
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HTMLmeta tags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90