agnes-the-ai-analyst/docs
Petr 26c4e0934d OSS cleanup: remove internal references, harden deployment, add config env interpolation
Phase 1 - Internal reference cleanup:
- Delete dev_docs/meetings/ (internal meeting notes/transcripts)
- Replace hardcoded usernames (padak/matejkys/dasa) with deploy/generic
- Replace "Internal AI Data Analyst" with "AI Data Analyst"
- Replace keboola/internal_ai_data_analyst URLs with your-org/ai-data-analyst
- Replace /tmp/keboola_load/ with /tmp/data_analyst_staging/ in dev_docs

Phase 2 - Deployment hardening:
- Tighten sudoers wildcards to explicit paths (visudo, sudoers cp)
- setup.sh creates all groups (data-ops, dataread, data-private) and deploy user
- webapp-setup.sh copies sudoers-webapp from repo instead of inline definition
- deploy.sh conditional copy for data_description.md (not in git for OSS)
- deploy.sh ownership changed to deploy:data-ops for /data/{scripts,docs,examples}

Phase 3 - Config and misc:
- Add ${ENV_VAR} interpolation to config/loader.py
- Expand config/instance.yaml.example with all sections (admins, deployment, auth, etc.)
- Create config/.env.template for secret values
- Add MIT LICENSE
- Fix .gitignore: add .venv/, docs/data_description.md
- Fix README.md: CSV status Planned, remove metrics/, update license text
- Translate Czech comments in requirements.txt to English
- Fix test_account_service.py: mock username mapping instead of relying on instance config

All 118 tests pass.
2026-03-09 07:59:57 +01:00
..
setup OSS cleanup: remove internal references, harden deployment, add config env interpolation 2026-03-09 07:59:57 +01:00
CONFIGURATION.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
DATA_SOURCES.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
DEPLOYMENT.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
GETTING_STARTED.md OSS cleanup: remove internal references, harden deployment, add config env interpolation 2026-03-09 07:59:57 +01:00
jira_schema.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
notifications.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
QUICKSTART.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
README.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00

Analyst Documentation

Documentation for analysts using the AI Data Analyst platform.

This folder is synced to all analyst machines in the server/docs/ directory.

Quick Start

Data Reference

Business Metrics

  • metrics/ - Standardized metric definitions
    • metrics/metrics.yml - Index of all available metrics
    • metrics/finance/ - Financial metrics (infrastructure costs, retention)
    • metrics/product_usage/ - Usage metrics (consumption, limits, telemetry)
    • metrics/sales_revenue/ - Sales metrics (MRR, ARR, expansions)
    • metrics/weekly_leadership_kpis/ - Weekly KPIs for leadership reporting

Tools & Integrations

  • notifications.md - How to send Telegram notifications from your analysis scripts
  • setup/ - Bootstrap configuration and Claude Code templates

For Developers

Server administration, development docs, and internal planning are in the dev_docs/ folder (not synced to analyst machines).