Initial commit

docs/adr/0000-template.md

@@ -0,0 +1,33 @@
+# ADR-0000: Title
+
+Date: YYYY-MM-DD
+
+Status: Proposed | Accepted | Superseded | Deprecated
+
+## Context
+
+Describe the problem, constraints, assumptions, and relevant background.
+
+## Decision
+
+Describe the decision that has been made.
+
+## Consequences
+
+Describe positive, negative, and neutral consequences.
+
+## Alternatives considered
+
+Describe alternatives and why they were not selected.
+
+## Security impact
+
+Describe security implications, if any.
+
+## Operational impact
+
+Describe deployment, monitoring, rollback, backup, restore, or operational implications, if any.
+
+## Rollback
+
+Describe whether and how this decision can be reverted.

docs/architecture.md

@@ -0,0 +1,13 @@
+# Architecture
+
+Describe the project architecture here.
+
+Include:
+
+- main components;
+- runtime dependencies;
+- data flow;
+- persistence;
+- external integrations;
+- deployment topology;
+- relevant ADRs.

docs/deployment.md

@@ -0,0 +1,15 @@
+# Deployment
+
+Describe how this project is deployed.
+
+Include:
+
+- environments;
+- Docker/Compose usage;
+- required configuration;
+- secrets handling;
+- exposed ports;
+- volumes;
+- networks;
+- deployment commands;
+- rollback procedure.

docs/operations.md

@@ -0,0 +1,13 @@
+# Operations
+
+Describe operational procedures.
+
+Include:
+
+- startup and shutdown;
+- health checks;
+- logs;
+- monitoring;
+- backup and restore;
+- routine maintenance;
+- known operational risks.

docs/runbook.md

@@ -0,0 +1,19 @@
+# Runbook
+
+Operational runbook for this project.
+
+## Common tasks
+
+Document routine operational tasks here.
+
+## Troubleshooting
+
+Document known issues, symptoms, checks, and remediation steps.
+
+## Rollback
+
+Document rollback procedures here.
+
+## Emergency contacts
+
+Document project-specific escalation paths if appropriate.

docs/security.md

@@ -0,0 +1,16 @@
+# Security
+
+Describe security assumptions and controls.
+
+Include:
+
+- authentication;
+- authorization;
+- network exposure;
+- TLS/certificates;
+- secrets management;
+- logging of sensitive data;
+- container privileges;
+- filesystem permissions;
+- dependency management;
+- relevant ADRs.

docs/testing.md

@@ -0,0 +1,23 @@
+# Testing
+
+Describe how tests are executed.
+
+All tests should run inside Docker containers.
+
+## Canonical test command
+
+```bash
+CHANGE_ME
+```
+
+## Test categories
+
+Describe applicable categories:
+
+- unit tests;
+- integration tests;
+- linting;
+- formatting checks;
+- Ansible syntax checks;
+- Docker/Compose validation;
+- smoke tests.