A foundational template for Platform teams to create an internal Temporal knowledge base. Built with Docusaurus.
See it live: go.temporal.io/platform-hub
Platform teams adopting Temporal often face the same challenges:
- Onboarding friction - Engineers spend weeks learning Temporal concepts scattered across docs, Slack threads, and tribal knowledge
- Repeated support questions - Platform teams answer the same "how do I..." questions repeatedly
- Inconsistent patterns - Without clear guidance, teams reinvent solutions and create tech debt
- Missing organizational context - Official Temporal docs are excellent, but don't cover your Namespace conventions, deployment patterns, or compliance requirements
Temporal Platform Hub provides a customizable starting point to address these challenges.
| Section | Description |
|---|---|
| Temporal Overview | Customizable intro to Temporal with space for your org's metrics and use cases |
| Decision Framework | Help developers determine if Temporal fits their use case |
| Getting Started | Environment setup and first Workflow guide |
| Learning Paths | Structured progression from basics to advanced patterns |
| Architecture | Document your Namespace conventions, Worker deployment, and connectivity |
| Cost | Temporal Cloud pricing model and cost optimization |
| Shared Responsibility | Define team responsibilities for Temporal applications |
| Patterns | Common Workflow design patterns with code samples |
| Troubleshooting | Observability and debugging guidance |
| Support | Support model and escalation paths |
| FAQs | Common questions and answers |
Each page includes instructions to help you adapt the content for your organization.
- Fork this repository
- Update
docusaurus.config.tswith your organization's details - Replace "ABC Financial" references throughout the docs with your organization
- Follow the
:::notebanners on each page for specific customization guidance
- Node.js 18+
- yarn
yarn installyarn startThis starts a local dev server at http://localhost:3000. Changes are reflected live without restarting.
USE_SSH=true GIT_USER=<USERNAME> yarn deployBuild and deploy the changes to GitHub Pages.
MIT