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 (4,021 stars) (400 forks)batch import
documentationgood first issue

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

Tech stack
pythonhtml
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic HTMLDocumentation toolchain
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the documentation templates in the repository, likely under a 'docs' directory. Look for the base HTML template (e.g., layout.html or base.html) and add Open Graph meta tags (<meta property="og:title" content="..."> etc.) for pages. Ensure the tags are dynamic based on page content. Test locally to verify unfurl on social media.