Bug 7934 - No OpenGraph info in TAG (for outside linking)
Summary: No OpenGraph info in TAG (for outside linking)
Status: NEW
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: LowPrio
Assignee: Bugzilla mail exporter
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-05-23 08:09 CEST by Pierre Ossman
Modified: 2022-11-30 14:19 CET (History)
0 users

See Also:
Acceptance Criteria:


Attachments

Description Pierre Ossman cendio 2022-05-23 08:09:32 CEST
Modern sites like to provide something with a bit more bling than just a text URL when linking to external pages. Instead, the targetted site can provide some text and graphics that should be displayed in a box that represents the link.

Since the Administrator's Guide will likely be linked to (e.g. to reference settings), we should make sure this works, so we have pretty links.

The easiest way is probably to add the Open Graph metadata to each page:

https://ogp.me/

As an example of a consumer of this data, we don't have to look further than our own community site.
Comment 1 Pierre Ossman cendio 2022-05-23 08:14:44 CEST
There's at least one Sphinx extension for convenient handling:

https://github.com/wpilibsuite/sphinxext-opengraph
Comment 2 Pierre Ossman cendio 2022-05-23 08:17:12 CEST
One problematic limitation is that URLs cannot be relative. That means if a user hosts their own copy of the documentation, then it will be difficult to make sure images and such are also grabbed from the user's servers.

We'll likely have to host such resources on our web server for all instances of the documentation.

Note You need to log in before you can comment on or make changes to this bug.