agnes-the-ai-analyst/dev_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
..
draft Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
design-system.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
desktop-app.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
disaster-recovery.md OSS cleanup: remove internal references, harden deployment, add config env interpolation 2026-03-09 07:59:57 +01:00
insights.md OSS cleanup: remove internal references, harden deployment, add config env interpolation 2026-03-09 07:59:57 +01:00
jira.md OSS cleanup: remove internal references, harden deployment, add config env interpolation 2026-03-09 07:59:57 +01:00
plan-corporate-memory.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
plan-rsync-fix.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
plan_parquet_types_fix.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
security.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
server.md OSS cleanup: remove internal references, harden deployment, add config env interpolation 2026-03-09 07:59:57 +01:00
session_explore.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
telegram_bot.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00

Developer Documentation

This folder contains documentation for developers and server administrators only.

⚠️ This folder is NOT synced to analyst machines - it stays on the server and in the git repository only.

Contents

Server Administration

  • server.md - Data broker server configuration and management
  • disaster-recovery.md - Recovery procedures for server failures
  • security.md - Security audit report and hardening guidelines
  • jira.md - Jira webhook integration and server-side processing

Application Development

  • desktop-app.md - macOS desktop app architecture and development
  • telegram_bot.md - Telegram notification bot technical docs
  • design-system.md - UI/UX design system for web applications
  • insights.md - Activity Center dashboard feature documentation

Planning & Meetings

  • plan-corporate-memory.md - Corporate Memory module implementation plan
  • meetings/ - Meeting transcripts, summaries, and notes

For Analysts

If you're an analyst looking for documentation on how to use the platform, see the docs/ folder instead:

  • docs/GETTING_STARTED.md - Quick start guide
  • docs/data_description.md - Data schemas and table definitions
  • docs/metrics/ - Business metric definitions
  • docs/jira_schema.md - Jira data schema reference
  • docs/notifications.md - How to use Telegram notifications in your scripts