Skip to main content

QUICKSTART

Status Dashboard - Quick Start

Status: Ready for installation
Priority: P2
Time to first dashboard: ~5 minutes

What You Get

3 auto-generated dashboards updated hourly:

  • LIVE-DASHBOARD.md - Complete status overview
  • HEALTH-TRENDS.md - Health metrics & trends
  • BLOCKER-ALERTS.md - Critical blocker alerts

Installation (5 Steps)

# 1. Navigate to directory
cd /Volumes/AgentPlatform/wikis/blueflyio/technical-docs.wiki/tools/status-dashboard

# 2. Install dependencies
npm install

# 3. Set GitLab token
export GITLAB_TOKEN="glpat-your-token-here"

# 4. Generate dashboard
npm run generate

# 5. View results
open ../../action-items/status/LIVE-DASHBOARD.md

Automation (Optional)

Hourly Cron Job

# Add to crontab
0 * * * * cd /Volumes/AgentPlatform/wikis/blueflyio/technical-docs.wiki/tools/status-dashboard && /usr/local/bin/npm run generate

Continuous Scheduler

# Run scheduler (updates every hour)
npm run schedule

What Gets Generated

LIVE-DASHBOARD.md

  • Executive summary (epics, issues, MRs, pipelines)
  • Epic progress with blockers
  • Issue metrics & velocity
  • MR health status
  • Pipeline success rates
  • Health trends
  • Quick action items

HEALTH-TRENDS.md

  • Overall health score (0-100)
  • Trend analysis (improving/declining)
  • Metric breakdown
  • Recommendations

BLOCKER-ALERTS.md

  • Total blocker count
  • Severity breakdown (critical/high/medium)
  • Epic-specific blockers
  • Recommended actions

Commands

# Generate all dashboards
npm run generate

# Quick status check
npm run status

# Collect data only
npm run collect

# Run scheduler (hourly updates)
npm run schedule

GitLab Token

Create at: https://gitlab.com/-/profile/personal_access_tokens

Required scope: read_api

Troubleshooting

"GITLAB_TOKEN required"

export GITLAB_TOKEN="glpat-xxx"

"Permission denied"

  • Check token has read_api scope
  • Verify access to blueflyio group

"Module not found"

npm install

Full Documentation

  • README.md - Complete feature documentation
  • INSTALLATION.md - Detailed installation guide
  • PROJECT-SUMMARY.md - Technical overview

Support

Issues: https://gitlab.com/blueflyio/technical-docs/-/issues
Contact: Platform team via Slack

Ready to use. Install and generate your first dashboard now.