@financial-times/n-syndication

n-syndication

Troubleshooting

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

What is n-syndication and how does it work

A client side library that displays icons next to headlines allowing syndication customers to download or save content for republishing.

• n-syndication wiki page gives some background context on how the icons work

See getting started on the authentication wiki page if you need to be added as a syndication subscriber.

You can develop with n-syndication without installing all of syndication. See instructions for local development and developing with a Next app.

If your app is failing locally as if you need the syndication API installed locally, you probably have some syndication port details in next-router's .env variables. Removing them should get the app to call the live production syndication API instead.

More information about the syndication system

• The Syndication Wiki explains the system and its architecture, including endpoints and authentication.
• Next Wiki covers GDPR SAR and erasure requests so that people without github access can read it, as it is automatically published to https://customer-products.in.ft.com/wiki/Syndication.
• Database Credentials & Key Rotation info related with key rotation in the systems

Local Development

$ git clone [e-mail]:Financial-Times/n-syndication.git
$ cd n-syndication
$ npm install

Run the (incomplete) test suite with

$ npm test

Verify that the Sass can compile by running

$ npx sass ./test/main.scss --load-path=./node_modules

And by running:

$ npx sass ./test/main.scss --load-path=./node_modules --load-path=./node_modules/@financial-times

Developing with a next app

Instruction for developing the library within a next app will be are in development (ACC-1156).

Deployment

Create a release tag in Github following the Semver convention and prefixing the release number with v. This will make this available as a NPM package at that version.

If you are wanting to deploy to FT.com, after creating the tag you will need to coordinate the release for these repos. You should create a pull request updating the package version in the repo's package.json.

This is just some javascript - is there other code elsewhere?

Yep - These links will probably be wrong pretty soon but will hopefully point you in the right direction:

n-teaser - https://github.com/Financial-Times/n-teaser/blob/main/src/presenters/teaser-presenter.js#L77 Here we add an additional modifier if syndication is available on this article

next-article - https://github.com/Financial-Times/next-article/blob/main/views/content.html#L20 Here a data attribute is added containing the syndication status of the article.

generic - add the following data attributes to your markup:

• data-syndicatable-uuid – the uuid of the content to syndicate
• data-syndicatable-title – the title of the content to syndicate
• data-syndicatable – yes / no / verify
• data-syndicatable-target – the element to insert the syndication flag