Skip to content
D Budge edited this page Oct 15, 2021 · 20 revisions

Syndication

This wiki covers syndication as a system.

For how to install and run each individual part of the system, you should look at the README.md file in the relevant repo.

Get added to a syndication licence if you want to work on the syndication API or UI.

There is a common misconception that you need all parts of Syndication to be running locally to test a single part of it. However, next-router will only look for a locally-running syndication API if it has the syn- environmental variables in the .env file.

Troubleshooting

All troubleshooting information is gathered in the Syndication API Troubleshooting runbook.

Quick Overview

Syndication (also known as Republishing), is the term for allowing other publishers to use our content in their own publications.

What do users see

Syndication Icons

Once the user has syndication licence, ft.com appears sightly different.

When on ft.com, users see coloured symbols next to the title of every article/podcast/video on the page.

ft_homepage.png

n-syndication has more information about how these icons are displayed.

Republishing Platform

On the top right corner on the page, the Republishing link takes users to the republishing platform.

republishing_menu.png

On the republishing tool, Users can see their contract details, allowance details and select their preferred download format.

republishing_platform.png

Users can also manage saved, downloaded and Spanish content.

Key systems

Client-side library that fetches which syndication icons, if any, to show to the user.

User-facing republishing app that allows people to manage their saved and downloaded articles.

This is the API called by the republishing app and by the syndication icons library.

Deploys next-syndication-api for the purposes of running the downloads as a separate application.

Uploads Spanish translations from an external provider to S3.

Database Schema repo. Allows you to set up the database locally.

All Diagrams

High Level Architecture

Syndication | Lucidchart

Cron Jobs

Syndication - Cron Jobs | Lucidchart

Sync Tasks

Syndication - Sync Tasks | Lucidchart

Cron Jobs

Syndication - Cron Jobs | Lucidchart

Sync Tasks

Syndication - Sync Tasks | Lucidchart

Authenticate Syndication User and Contract

authenticate diagram

Save for later

Save for later diagram

Download

Download diagram

Display Syndication Icons on FT.com diagram

syndication icons diagram