What is Sanity?
Sanity is the CMS (Content Management System) used to host data for RBI’s digital platforms. Sanity will host your menu, restaurant data, marketing images, navigation, footer, etc.
In a nutshell, you can customize your entire Website or App in this platform.
Look and Feel
The Content Management System is a website that can be accessed via your browser to edit your Website and App data.
| Info |
|---|
To get access to Sanity, you need to request your RBI’s tech contact to add your email to the accessibility list for your country |
After you log in to the RBI Sanity Studio, you can see four major folders into which the content is divided.
Order Level Content
Marketing Content
CTG Configs
Deprecated
Order Level Content
This folder contains all the documents that affect configurations at the order level
It is further divided into the following folders:
Loyalty: Contains all documents required to set up loyalty for your platform.
Menu: Contains all documents required to successfully set up the menu structure for your solution. The majority of the information is captured as an input by the Sanity user, however, some of the information is retrieved from MDM - if you don’t know what MDM is please click here.
Restaurants: Contains all restaurant information for the market that includes
a list of each restaurant with their details,
the creation of restaurant groups,
and the setup of restaurant amenities.
| Note |
|---|
About 90% of the restaurant information is retrieved from MDS and only 10% is editable through Sanity. |
Marketing Content
This folder contains all documents that will affect marketing level configurations within the platforms. The most known features you can create in this section are new platform pages, and marketing tiles, but the capabilities of this piece are virtually unlimited
It is further divided into the following folders:
A/B Testing: Contains the setup for A/B testing scenarios included within Sanity.
Components: Contains a series of components that are used in the various features in your platform. Each component is tagged to a specific functionality.
Features: Contains a wide range of features available in your platform that pulls certain content from Sanity. Each folder corresponds to a specific feature.
Kiosk: Contains all content for your kiosk that is unique to your platform. It differentiates kiosk from other platforms, such as web and mobile app.
Static Pages: Contains documents named static pages, which are used to maintain static content and display it in the best way for your guests.
CTG Configurations
This folder contains information related to configuration, support, and other content internal to the RBI team. The RBI internal team manages this content to set up your business platform as a franchisee. Configurations to connect with the different vendors (PSP, POS,…) are managed through this pannelpanel
Note: Folder access is restricted to the RBI internal team only. You do not have access to this content.
Deprecated
This folder acts as an archive. It includes existing folders that are no longer required and must be removed. It might be that someone in another part of the globe is still transitioning to deprecate that feature and so it remains here for limited time.
Environments and Front End
| Tip |
|---|
Your website will always be hosted in 4 development environments:
These are used according to the best practices of Software development, and will minimize the chances of wrong developments or wrong content configurations from being seen by your guests. |
All 4 environments can be accessed via your browser and will be password protected, meaning you should request access to your RBI tech manager to gain access.
The pictures below show what you should expect to find - password protected websites, and similar content displays among the different environments.
However, development teams rely heavily on using the lower environments (Dev, Staging, and QA) to develop new features. You will find discrepancies among environments, and some features might even malfunction for short periods of time.
| Tip |
|---|
This should not keep you from testing all your content changes prior to moving them to Production |
| Note |
|---|
Please request access to your RBI tech contact for the respective links for your market |
Each of the Environments also has a respective Sanity link, meaning for each Environment you will have:
One Front End Link
Which will work like your website URL where you can actually see the website.
One Sanity Link
Which will access your CMS for that environment. Making changes to Staging will affect Staging environment only.
Best Practices
| Warning |
|---|
Do not edit any data directly on any environment other than Staging |
Whatever happens, you should never ever edit data in Production, and strongly avoid editing in QA. Staging should be your go-to environment to make any changes. Wrongly editing data in other environments will increase the chances of mistakes arriving to Production, which can cause platform breaks. Mistakes handling with the platform’s content might break online ordering, causing big financial losses. Do not forget that Menu and Restaurant data are edited in Sanity, and that brings a lot of responsibility to its users.
| Tip |
|---|
Edit content in Staging, test it. If everything works correctly, move to QA, and test again. Only then migrate to Production. Do not mimic your content changes through environments. We have a tool to automate your migrations and make your job easier: Sanity Migrations Tool |