Terminology

The words Obelism Content uses, from organization and space to entry, block, draft, locale, delivery token and site session.

4 min read

Where content lives

Organization: the customer. Owns spaces and the people who work in them, with one role each. Shared by every Obelism product and managed on www.obelism.studio.

Space: one site or project of an organization, with its own content model, content, assets, locales and API tokens; the same space in every Obelism product. See spaces and settings. An organization with a marketing site and a help centre has two spaces. Every organization has at least one: a new one starts with a space called Default, in English.

Environment: develop, staging or production, which every space has. Each holds its own copy of the content model and the content. Moving them from one environment to the next is promotion. See environments.

Shopify store: the Shopify store connected to a space, the same in every environment. Its collections and products are picked in Shopify fields. A space has at most one.

The content model

Content model: the content types of one space environment, defined by you.

Content type: a schema identified by its API id (blogPost), the same in every environment. Its kind is page (entries with a URL), data (entries without one) or block (parts of a page, inside a blocks field; a block type can also have entries of its own, shared blocks).

Field: one named, typed value on a content type. A localized field holds one value per locale.

Model file: the content model as one JSON file, kept in a repository and synced by plan (what would change, and what stands in the way) and apply (make it so, all or nothing). See the model in Git.

Content

Entry: an instance of a page, data or block content type. Keeps the same id in every environment. A folder is an entry without a content type that groups entries in the tree.

Block: an instance of a block content type inside an entry, with a _uid that is unique within the entry. A shared block is a block type's entry of its own, reused across pages; a page's blocks field references it with _type: "_shared". The improve block (_improve) is the built-in block with different blocks per variant of an A/B test or flag.

Draft and published: every entry has a draft, which is all editing changes, and, once published, a published copy, which is all the delivery API serves. An entry has unpublished changes (status Changed) while its draft is ahead. Saving checks value shapes; publishing also enforces required fields. See publishing.

Version: every save and publish of an entry, kept in its history (the newest 100) and restorable as the draft.

Review: in an environment whose publishing is reviewed, editors and developers ask for review and an admin approves (publishes) or sends it back. See review before publishing.

Schedule: a set time at which an entry publishes or unpublishes, as the person who scheduled it.

Trash: where deleted entries stay for 30 days, restorable as drafts.

Redirect: the old path of a page that moved, still pointing at it. See redirects.

Slug and path: a page's slug is its own URL segment; its path is the slugs of its ancestors and itself joined with / (blog/hello). Paths are unique within an environment. A page has a slug, and so a path, per locale.

Locale: a language a space publishes in. The default locale must be filled in before publishing, and every fallback chain ends there. See locales.

Asset: an uploaded file, belonging to a space and shared by its environments, with alt text and a title per locale and a focal point that crops keep. A private asset is only served with a signed URL. See assets.

Link: a field value that goes to a page of the space, any address or a Shopify product, with an optional query and anchor. See links.

Product page and collection page: a page about one product or collection of the space's Shopify store, for what the store doesn't hold. See Shopify.

Delivery

Delivery API: read-only access to one space environment's content, for your site, with a delivery token (published content) or preview token (drafts too). See API tokens.

Management token: acts as the person who created it, from a repository or a script: with the model scope it syncs the content model, with the content scope it writes content. See API tokens.

Webhook: a request sent to your site when what the delivery API answers changes. Each send is a delivery.

Promotion: copying content, and optionally the model, from one environment to another, after a plan of what will change. See promoting.

Canvas: the dashboard view that shows every page of your site side by side, at the environment's preview URL, with the selected page's fields next to it.

Site session: an editor signed in to edit on your own site, with a site token. Drafts show (draft mode), and they can prompt, save and publish. Lasts a working day.

On this page

Marks in the margin

  • Note
  • Watch out
  • Updated

Scribes marked doubtful lines in the margin. That practice is called obelism.

Stuck on a step?