In a nutshell, you can customize your entire Website or App in this platform.
Sanity is the CMS (Content Management System) used to host content for RBI’s digital platforms. Sanity will structured and host your restaurant data, menu, marketing images, navigation, promotion and etc.
You should request access for your Customer Success Manager.
Your website will always be hosted in 4 development environments:
Development
Staging
Quality Assurance (QA)
Production
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.
Mainly, engineers team rely on using the lower environments (Development, Staging and Quality Assurance) to develop new features. 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.
Noticed that making changes to Staging will affect Staging environment only.
Request for your Customer Success Manager the respective links for your market.
Essentially, franchisees focus on Staging and Production environment.
Staging environment: it is the place where you will create and tested the content and the real users are not access.
Product environment: it is the place where the content is published for real users.
You should start produce a new content on Staging environment and once the content is ready to be published to production, you should use the process of Sanity Migrations.
Sanity Migrations allow you to independently migrate content from Staging to different environments.
According to best practices of content management, new content should be created and tested on Staging environment and afterwards published those changes to Production environment.
You will need a write token in order to use this tool. If don’t have one, request it from your Customer Success Manager. Make sure to save it locally on your computer so you can re-use it, but please DO NOT SHARE THIS TOKEN, as it is a user-specific token. |
There are two ways to migrate content, through the GROQ query in the Migration tool or migrate an individual document.
Staging should always be the source of truth to migrate changes to other environments (e.g. staging → production) |
The Migration tool can be found on the top navigation menu in Sanity.
The Migration tool allows you to migrate multiple documents using a GROQ query, as opposed to only moving the currently viewed document. In terms of functionality, the actual migration tool works the same as the document action.
Once you input your token, you’ll be prompted to input a GROQ query that refer to the document you’d like to move:
Below you can find the most used queries for your use:
MIGRATES WHOLE MENU BUT DOES NOT INCLUDE OFFERS: *[_id in ["feature-menu-singleton"]][0..10000]
MIGRATES ALL OFFERS: *[_id in ["feature-offers-singleton"]][0..10000]
MIGRATES ALL STATIC PAGES: *[_type in ["staticPage"]][0..10000]
PUSHES WHAT WE SHOW ON THE HOMEPAGE: *[_id in ["feature-home-page-singleton"]][0..10000]
UPDATES ONLY MARKETING TILES: *[_type in ["marketingTile", "marketingTileGroup"]][0..10000]
MIGRATE ALL DOCUMENTS WITH TYPE ‘ITEM’: *[_type in ["item"]][0..10000]
MIGRATES ALL DOCUMENTS WITH TYPE ‘OFFER’: *[_type in ["offers"]][0..10000]
MIGRATE ALL INFORMATION: *[]
You can also build your own GROQ queries, more information on GROQ here.
This process will also move children documents associated to the documents you’re migrating |
Once you’ve inputted your query, you’ll need to select your destination dataset – typically prod_[brand]_[country].
After that you can click on Migrate. When the migration is done, you should get a message indicating Migration Successfully Complete!
If you would like to only migrate a specific document, you can make use of the document migration feature.
To migrate an individual document, follow the instructions below:
This process will also move children documents associated to the document you’re migrating |
Next to the Publish button you will find a dropdown menu with the option Migrate.
Upon clicking on Migrate, you will be prompted to input your token.
Similarly to the migration tool process, you will need to select the destination dataset.
If there is changes to migrate, click on the Migrate button and wait for the migration to finish. Do not close the pop-up until the migration is complete.
When the migration is done, you should get a message indicating Migration Successfully Complete!