Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 3.64 KB

README.md

File metadata and controls

62 lines (45 loc) · 3.64 KB
Raw

Thoth

Thoth is a GitHub repository engineered as a plain text files provider, hence working as a service that allows your application to read plain text files' raw content (meaning they can not contain any logic) just by accessing their URL in the platform.

This project follows Herodotos version 211105.1. Use the documentation entrypoint to find out about this project.

Fancy notifications

The main use case for this repository is to allow any product to show content that is likely to be changed over time without the hassle of neither changing the code that consumes it, nor compiling/deploying it.

Use case example:

Marketing department needs to change a commercial message before seasonal sales. Instead of hardcoding those messages into your UI, compiling the project (if that's the case) and deploying it every time that message needs to be changed, you can simply add a message in Thoth and read it from your application on demand. To update that commercial message, just change the file notifications in Thoth and you are done.

The message needs to be in notifications.json file and to be like the next example, you can find more information on which options you can use here:

{
  "id": "BLACK_FRIDAY_2022",
  "lang": "en",
  "products": ["addin"], 
  "licenseStatuses": ["trial"],

  // these are optional
  "startDate": "",
  "endDate": "",
  "solutions": ["word"],

  // this is optional, but if you want info in your notification, you need to write title
  "info": {
    "title": "BLACK WEEK MATHNESS",
    // this is optional
    "text": "Enjoy 30% OFF for MathType Office Tools.<br/><br/><a style=\"text-decoration:underline\" href=\"https://store.wiris.com/en/individual/purchase/step1?code=BLACK22FAI&utm_source=Product&utm_medium=MathTypeMS365&utm_campaign=FancyNotification&utm_term=BlackFriday2022&utm_content=GETITNOW\" target=\"_blank\">Get 30% discount</a>"
  },

  // this is optional, but if you want to put an image, you need to write the url, the altText and the target
  "image": {
    "url":"https://assets.officetools.wiris.kitchen/gifs/black-week-sales.gif",
    "altText": "Take advantage of MathType's black week and get now a 30% off.",
    "target": "https://store.wiris.com/en/individual/purchase/step1?code=BLACK22FAI&utm_source=Product&utm_medium=MathTypeMS365&utm_campaign=FancyNotification&utm_term=BlackFriday2022&utm_content=GETITNOW"
  },

  // This is mandatory, number of times you want to show the notification to the user
  "visualizations": 3,
  // This is mandatory, it needs to be a number (more priority, greater number).
  "priority": 1,
  // This is optional, the possibilities are "error", "success", "info" and "warning"
  "alertType": ""
}

Notice that ID groups notifications for the same event but different targets (products, languages, etc).

Request to upload images to https://assets.officetools.wiris.kitchen/ (#devops-support) if you don't have credentials. At least until there is another way to do it.

Who's to Blame

This project is maintained by the engineering team, thus, in order to make use of it you must contact the authors in the following channel:

Feel free to leave feedback, report bugs or just come to tell how cool this project is. Moreover, this document provides insights on how to report an issue.