An Eliware workspace template for indexed role guidance, ownership, communication, and recovery.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- Runbooks
- Communication
- Recovery
- Support
- Links
- License
This template organizes role guidance, local procedures, decisions, and recovery steps. Each derived workspace defines its role owners and decision boundaries.
Use Node.js 26 or later and npm 12 or later for repository validation.
Create a repository from this template. Set its name, description, URLs, keywords, role owners, and decision boundaries.
Replace the sample guidance and procedures with approved content for the derived workspace.
Keep implementation and shared policy in their owning repositories.
Run npm ci from the repository root.
Read the workspace guide before you adapt the template. Use the runbook index to find the sample procedures. Read the release notes for changes in each template version.
Read AGENTS.md before you change files. Use the specifications index to find structured requirements.
Run npm test before handoff. It runs aggregate repository checks through eliware-test.
If npm ci fails, use Node.js 26 or later and npm 12 or later.
If npm test fails, read the reported file and rule.
Fix the source document.
Run npm test again.
Keep credentials, secrets, private data, and runtime state out of Git. Use an approved secret store for each secret value.
The template repository is public. package.json sets private to true, so npm publication is disabled.
The template has no container publication workflow. Set source visibility and publication options for each derived repository.
Store each local procedure in a separate .yaml file under runbooks/.
List each procedure in the runbook index.
Use the workspace guide for the shared schema and adaptation steps.
The sample runbooks are incomplete examples. Replace each placeholder in a sample runbook. Ask the owner to confirm the completed procedure before use.
Use your organization's approved communication channel for cross-role release decisions and company-wide procedures. Use GitHub Issues to name work owners and record status, blockers, and required actions.
Keep workspace-specific recovery steps in local runbooks. Follow the approved recovery procedure for the affected role. Follow the cross-role recovery procedure that your organization approves.
For help, questions, or to chat with the author and community, visit:
