Terminology

A reference guide for terminology used by Stringtale, categorized and sorted alphabetically.

General terms

API key

An API key authenticates requests to the Stringtale API (environment variable: STRINGTALE_API_KEY). Keys can be read-only or have write permissions. See Obtaining an API key.

Dashboard

Stringtale’s Dashboard is the main web UI where you can manage Workspaces, Projects, Users and API keys.

Optional setting on an API key (Enable login). When enabled, editors must sign in before they can change text on the preview environment. See the browser extension guide.

Project

A Project represents a Stringtale integration, typically for a single product / repository or a monorepo for a single client. Other setups are possible as long as the name values used by <Value> tags remain unique within the Project.

Workspace

A Workspace is a collection of Projects. It allows you to share the same user access rights across multiple projects. We recommend using Workspaces to group Projects of a single client.

Tools

Browser Extension

The Stringtale browser extension simplifies the usage of Stringtale. It allows users to open the Stringtale interface on every project that makes use of its integration and allows them to make changes.

CLI

The Stringtale CLI is a utility to retrieve changes that are stored in Stringtale and apply them to your project. This can be used locally for a hands-on approach, but also gets used by the GitHub Action to automatically create pull requests.

GitHub Action

The GitHub Action allows you to automatically pull copy changes into your project using GitHub Actions. It can be either triggered by conditions set in a workflow YAML file, or using webhooks.

User types / User roles

Billing admin

Billing admins are users with limited access to Stringtale. They can only manage the Billing information and view invoices.

Developer

Developers have full access to the Stringtale Dashboard except for the Billing information. They can manage Workspaces, Projects and Users within your Stringtale account.

Editor

Editors are users with limited access to Stringtale. They are user accounts scoped to one or more Workspaces, allowing them to make copy changes to projects within that Workspace. Editor accounts are especially useful when a preview environment is publicly reachable and you have enabled editor login.

Owner

Owners have full control over the Stringtale account. They can add/remove Workspaces, Projects and Users as well as manage the billing information and invoices.

Technical terms

Value tag

All text that needs to be editable with Stringtale has to be wrapped in a <Value> tag with a name property. Example: <Value name="src.index.example">Example</Value>. More information can be found in the React front-end documentation.