FAQ

FAQ publishes short answers to questions that apply across Cloud rather than to one application's workflow. Each visitor sees only the entries selected for their audience, while administrators maintain the complete list.

Use FAQ

• Scan the public FAQ for a question that matches the current task or problem.
• Open one answer at a time and follow links to longer app-specific Help when needed.
• Write one direct question and Markdown answer in English, then add a German translation when the topic should be available in German.
• Choose whether an entry is visible to anonymous visitors, guests, users, or more than one audience.
• Update or remove entries when the owning product behavior changes.

Audience filtering controls visibility; it is not a safe place for secrets or private operational data.

Understand the FAQ model

FAQ is for compact cross-cutting answers. Detailed product procedures stay in the Help surface owned by the relevant application.

English is the complete base content. Locale resolution uses an exact locale, then its language ancestor, then English for each entry. For example, de-CH uses de when present and otherwise falls back to en.

How FAQ fits Cloud

FAQ owns entries, audience selection, ordering, and the public and admin surfaces. Cloud supplies visitor identity, admin authorization, Postgres, Markdown rendering, legal-link placement, OpenAPI publication, and the shared Help shell.

Find detailed product help

Open Help on the FAQ page for audience behavior and finding answers. The admin page has guidance for writing and maintaining entries. Developers can read Authentication, Route policies, and Public API surface for the shared boundaries FAQ uses.

Manage FAQ from the terminal

Administrators can manage the same entries and ordering through the dedicated FAQ CLI. Put the localized Markdown in JSON so shell quoting stays simple:

cld faq list
cld faq get <id> --json
cld faq create --translations-file ./translations.json --audience anonymous,guest
cld faq update <id> --translations-file ./translations.json --audience user
cld faq reorder <id> <id> <id>
cld faq delete <id> --yes

Each translations object must include en; it may contain any additional valid locale. Run cld faq help for file, standard-input, and structured-output options. FAQ CLI operations require an administrator; the public FAQ page performs its own audience filtering.

Deployment requirements

See Deployment requirements for this app’s startup prerequisites, optional integrations, configuration and functional checks.