Begriffe
Workspace, Website, Bereich und Seite – wie Docsello Inhalte ordnet.
Docsello ordnet alles in vier Ebenen:
Workspace → Website → Bereich → Seite
(Team) (Domain, (eigene (Markdown,
Startseite, Navigation, Verlauf,
Design) Zugriff) Übersetzungen)Workspace
Ein Workspace gehört einem Team oder einer Firma und ist von allen anderen Workspaces komplett getrennt: eigene Mitglieder, eigene Bereiche, eigene API-Tokens und eigene Anmelde-Anbieter. Wenn du Zugriff auf mehrere Workspaces hast, wechselst du oben links in der Verwaltung zwischen ihnen. Jeder Workspace ist unter einer eigenen Subdomain erreichbar und kann zusätzlich eigene Domains bekommen.
Mehr dazu: Workspace verwalten.
Website
Die Website ist das, was Leser sehen: Startseite, Design, Kopf- und Fußzeile, Domains und SEO-Einstellungen. Du findest sie in der Verwaltung unter Startseite (Seitenleiste, Abschnitt Website). Siehe Startseite.
Bereich
Ein Bereich ist eine eigenständige Dokumentation mit eigener Navigation, Sichtbarkeit und eigenen Berechtigungen –
zum Beispiel „Handbuch“, „Entwickler“ oder „Intern“. Seine Adresse ist der erste Teil der URL:
https://docs.example.com/handbuch/…. Es gibt drei Arten:
| Art | Wofür |
|---|---|
| Dokumentation | Seiten mit Navigation – der Normalfall |
| Changelog | Datierte Einträge mit RSS-Feed, z. B. Release Notes |
| API-Referenz | Wird aus einer OpenAPI-Spezifikation erzeugt, siehe OpenAPI-Referenz |
Mehr dazu: Bereiche einrichten.
Seite
Seiten enthalten den eigentlichen Inhalt in Markdown. Sie können verschachtelt werden (Unterseiten), haben einen vollständigen Verlauf und können in mehreren Sprachen existieren. Zusätzlich gibt es Gruppen: Sie erscheinen als Abschnitts-Überschrift in der Navigation und haben keinen eigenen Inhalt.
Jede Seite hat einen Entwurf und eine veröffentlichte Fassung. Was du im Editor änderst, wird automatisch als Entwurf gespeichert; Leser sehen es erst nach dem Veröffentlichen.
Adressen auf einen Blick
| Was | Adresse |
|---|---|
| Seite | /<bereich>/<seite>/<unterseite> |
| Seite in einer anderen Sprache | /<sprache>/<bereich>/… (die Standardsprache der Website hat kein Präfix) |
| Eingefrorene Version | /<bereich>/v/<version>/… |
| Rohes Markdown einer Seite | Adresse der Seite + .md |
| Verwaltung | /admin |