Financial-Times / ft-origami

The Old Origami Website, do not use
https://github.com/Financial-Times/origami
76 stars 12 forks source link

Propose a new "supportContact" property #567

Closed rowanmanning closed 6 years ago

rowanmanning commented 6 years ago

This introduces a new supportContact property in the origami.json spec. This property is used to document support contact details of the team that maintains a component or service. It also deprecates the use of an email address in the support property.

I'm proposing this so that the support details of a component are more strict and readily machine-readable - we need this for the repo data service, which will use the information to differentiate between Origami components that are maintained by the Origami team vs another team.

The support property is also nearly always a GitHub issues URL in our components, which means contact details are stored nowhere in the repository.

Probably easier to review as a diff on the rendered markdown: https://github.com/Financial-Times/ft-origami/pull/567/files?diff=unified&short_path=579588b#diff-579588b25574dbfdd111c33b7f9ecee7