Intro
How to navigate this guide#
This guide was designed so that all users can make the most of the backoffice, whether they have experience working with it or have never seen anything like it. You can find in this guide several tutorials but also solutions to common problems, tips to take advantage of the backoffice in the most efficient way, etc.
On the FAQ page, as the name implies, you can find several frequently asked questions and their respective answers. Feel free to take a look because you never know if any of these questions is yours too.
On the How To page you will find detailed explanations on how to do several tasks, from creating a new document to deploying your site.
The Tips page contains tips on how to save time on some tasks, make them simpler and even suggestions for other useful tools.
On the Troubleshooting page, you can find information to help you get around some common difficulties you might face. If something is not working as you expected, this page might help you fix your problem.
Finally, you'll find the Bugs and Workarounds page. Since this backoffice is based on a third party service called Sanity, there are some bugs whose solution is out of our control. In this page you can find the bugs that we currently know of, and workarounds for them.
Terminology#
In order to make the rest of the guide clearer, this section explains some common terminology used throughout the guide.
Sanity: The service that powers this backoffice and where your data is stored. You can learn more about Sanity here.
Netlify: The service where both this backoffice and the website are hosted. It's also responsible for building the website before hosting it whenever you deploy it. You can learn more about Netlify here.
Document: A document is what you create and edit in the backoffice — all data you may edit lives inside a document. All documents have a type, for example, each Product is a document of type Product, each Crop is a document of type Crop and so on. For most types of document you can create new documents, edit them and even reference them from other documents (e.g. a Product document might reference the Crop documents that it targets). However, there are some special types of documents (e.g. Homepage, Who We Are, etc.) of which there is (and always will be) only one document.
Field: A field is where you can insert your data inside a document. The most common field is the text field, but there's also date fields, image fields, number fields, rich text fields, etc.
Published/Draft: When you create a document, it starts as a Draft, only after you Publish it does it appear on the website. If you then make new changes to this document, these changes are also stored as a Draft, and will only appear on the website if you Publish the document again.
At the bottom left of a document's window, you can both see if a document has been Published and whether it has Draft changes.
Sections: The backoffice is divided into four sections: Dashboard, Desk, Media and Guide. You can access these sections through the top navigation bar or by clicking on the Menu Icon in the top left corner, depending on the device you're using.
Dashboard: In here you can see which documents have been last edited, deploy your website or see who are the project users working alongside you.
Desk: The main section of the backoffice. Here is where you find all content of your website and where you can edit and publish it.
Media: In this section you can keep track of all the images that have been uploaded in your website. It is possible to sort them, see which images aren't being used, see its properties, etc.
Guide: The section you are in right now.