Authors and Operators

This folder is the operational manual for everyone working with the SAP Developers tutorial system. It replaces the historical meta-tutorials run-book.

Pick your persona

If you are a...	Read	What you do
Tutorial author writing markdown	writing-tutorials.md	Write, preview, and publish tutorials
New tutorial author learning the ropes	meta-tutorials.md	Follow the platform's own "how to write a tutorial" tutorials (on the QA channel)
Repo group owner in sap-tutorials	repo-group-owners.md	Review PRs, plan tutorials, manage your repos
Center admin running the platform	center-admin.md	Catalog, taxonomy, pipeline, access, support
Analytics admin exploring usage	analytics-admin.md	Run queries, monitor events, export data

Branching paths (issue #172)

• Authoring branched missions — pick-one alternatives within a mission
• Authoring branched tutorials — alternative step-runs and skip-runs within a single tutorial
• Branching cookbook — copy-paste examples for cloud/on-prem, IDE pick, and skip-ahead
• Reading branch telemetry — how to interpret the Branch Performance section in the Missions admin app, and when the staleness lint suggests collapsing a branch.

System landmarks

• Source repos — sap-tutorials GitHub organization (one repo per topical group)
• Platform repo — sap-tutorials/tutorials-ims (this repo)
• Admin UI — /admin-ui/ on the deployed app (XSUAA-gated, Admin scope)
• Analytics UI — /analytics-ui/ on the deployed app (Admin scope)
• Public site — https://developers.sap.com/tutorials/<slug>
• HANA Cloud — managed instance bound to the CAP srv app; backups via BTP cockpit
• Cloud Foundry — dev and prod spaces in the tutorial-system subaccount

Adding a task that isn't here yet

If you find yourself doing something operationally important that isn't documented:

1. Decide which persona file it belongs in (or whether it's a historic mapping for ../historic/).
2. Use the standard task template — heading with verb-led title, Interval, Status, Purpose and Objective, Prerequisites, numbered steps, Related links.
3. Open a PR against this folder.

Tools that complement these docs

• Sage VS Code extension — author-time linting and preview.
• QA channel — author-preview for *-Contribution repo content (Tutorial.Author scope required).

Deeper technical references

• build.md — fetch → parse → Hugo → HANA in detail
• mta-deployment.md — how the MTA is structured and deployed
• authentication.md — XSUAA, role collections, IAS
• testing-endpoints.md — canonical endpoint reference for smoke testing

Historic context

• historic/decommissioned-tasks.md — historic task mapping

Updating the docs site sidebar

When you add a new page under docs/end-users/, docs/authors/, docs/developers/, or docs/historic/, you must register it in the sidebar at docs/.vitepress/config.ts under the matching persona block. The build runs scripts/check-docs-sidebar.cjs as predocs:build — it fails with a clear diff if a page is unregistered or a link is dead.

Run locally to verify:

npm run docs:build