Glossary

The words these docs use for the parts of Quillet, in alphabetical order, each with the Concepts page that explains it.

CLI key

A CLI key is the credential the CLI and CI jobs work with. It belongs to one project, reaches every environment or one, and holds only the scopes it was given, such as content:read, content:write and content:publish. It never has the owner role, so it cannot manage keys, members, webhooks or environments. Its key id starts qk_ and its secret is shown once; an owner makes one under Settings → Keys. See Access.

Component

A component is a reusable shape for structured content, such as a hero, a call to action or a page made of sections. It lists fields, says which are required, and refuses a save that does not fit. You build one in the dashboard's Components tab; underneath it is a JSON Schema stored as the document _schemas/<name>, so it is versioned and published like any other document. A document that follows a component is an instance of it. See Components and pages.

Delivery key

A delivery key is the credential a website reads with. It reads published content, in the one environment it was made for, and can never write. It is two halves, a key id that starts qk_ and a secret that starts qs_; the secret is shown once, when the key is made, and the CMS keeps only a hash of it. An owner makes one under Settings → Keys. See Access.

Document

A document is one piece of content in one locale and one environment: a guide, a page, a block of settings. It is structured JSON, Markdown or plain text, it has a key, and every save keeps a new version of it. See Documents, keys and folders.

Environment

An environment is a complete, separate copy of a project's content, such as prod for the live site and staging for rehearsals. A project starts with one, prod. Documents, versions and delivery keys belong to one environment; files and members belong to the whole project. See Environments and promotion.

Folder

A folder is the part of a key before a slash: guides/welcome is in the folder guides. Folders are not created or stored on their own; a key implies them. A folder's settings, such as its title, its order among its neighbours or a component for every document in it, live in a document called _index inside it. See Documents, keys and folders.

Key

A key is a document's address within its environment: a path of segments joined by slashes, such as landing/pricing/faq. A segment is lowercase letters, digits, dots, dashes and underscores, and starts with a letter or a digit; the few that start with an underscore, such as _index and _schemas, are reserved. The same key in two locales is two translations of one document. A site asks for content by key, and a key's leading part is its folder. See Documents, keys and folders.

Locale

A locale is a language for a place, written as a tag such as en-US or de-DE. A project lists its locales and names one as the default. A structured translation that leaves a field out takes it from the default locale, field by field; a Markdown or text document with no translation is served whole in the default locale. See Locales and fallback.

Page

A page is a document whose component describes a page: one marked page: true, usually with SEO fields and a list of blocks. It is stored, versioned and published like any other document. What sets it apart is the dashboard: it lists pages under Pages and opens each with Content preview beside the form, so you see the page before anybody publishes it. See Components and pages.

Personal token

A personal token is a credential that acts as you, with your role in every project you belong to. You make one on the dashboard's Account page for the command line and other tools; it lasts 90 days unless you choose otherwise, and its secret is shown once. If you are an owner, it can do an owner's work, such as adding members, which a CLI key is never allowed to do. Only you, signed in to the dashboard, can create or revoke tokens, create a project, list your projects or list a project's members; a token gets a 401 or a 403 there. See Access.

Promotion

Promotion moves chosen changes from one environment into another: compare staging with prod, pick the rows, and write them into prod as new versions in one step, published or as drafts. The source is read and never written. If the target has changed since you compared, the promotion stops rather than merge the two edits: which one wins is a person's decision. See Environments and promotion.

Publish

To publish is to make one version of a document the one readers get. It is a separate act from saving: a save keeps a new version and changes nothing for readers, and a publish changes what the delivery API serves. Before it happens, the dashboard says what else changes with it. Several documents can be published together as one decision. See Versions and publishing.

Reference

A reference is a field that points at another document instead of holding a copy of it, written {"$ref": "<key>"}. When a site reads the document, the delivery API puts the published body of the one it points at in place of the reference, in the same locale. Change the shared document, publish it, and every page that refers to it shows the change. See Components and pages.

Version

A version is one saved state of a document. Every save adds one, numbered from 1, and none is ever changed afterwards. One version may be published; restoring an old one saves its content again as the newest version, so history only grows. See Versions and publishing.

Webhook

A webhook is a message the CMS sends to an address of your choice when something happens, such as a publish, a delete or a new environment. It names what changed and carries no content: the receiver, often your site, reads the new content through the delivery API. Each message is signed, so the receiver can check it came from your CMS. See Integrating a site.