# doc-control-ops

> Operational workflows, command recipes, and troubleshooting for the doc-control repository. Use when running audits, collecting Mattermost/Redmine data, starting/stopping Django UI/API and workers, managing configs and env, running quality gates, or diagnosing common failures in doc-control.

- Author: Alexey Pchelintsev
- Repository: aa-pchelintsev/doc_control
- Version: 20260208002028
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/aa-pchelintsev/doc_control
- Web: https://mule.run/skillshub/@@aa-pchelintsev/doc_control~doc-control-ops:20260208002028

---

---
name: doc-control-ops
description: Operational workflows, command recipes, and troubleshooting for the doc-control repository. Use when running audits, collecting Mattermost/Redmine data, starting/stopping Django UI/API and workers, managing configs and env, running quality gates, or diagnosing common failures in doc-control.
---

# Doc Control Ops

## Overview

Provide repeatable, low‑friction workflows to operate the doc-control repo safely and fast.

## Quick Start (pick a path)

- Run an audit with viewer → use `scripts/dc_ops.py audit`.
- Run a headless audit → use `scripts/dc_ops.py audit --no-viewer`.
- Collect Mattermost or Redmine → use `scripts/dc_ops.py collect`.
- Export docs to Markdown → use `scripts/dc_ops.py export`.
- Sync export to Google Docs/Sheets → use `scripts/dc_ops.py google-sync`.
- Start Docker UI/API + worker → use `scripts/dc_ops.py dev`.
- Ensure worker container is up → use `scripts/dc_ops.py worker`.
- Run DB migrations as a separate step → use `scripts/dc_ops.py migrate`.
- Run full quality gates → use `scripts/dc_ops.py quality`.
- Run real benchmark (monthly cadence) → use `scripts/dc_ops.py bench`.
- Profile offline hotspots → use `scripts/dc_ops.py profile`.
- Need more detail → read `references/workflows.md`.

## Use The Helper Script

Run the helper from the repo root (no extra flags needed).

Example:
```bash
uv run python skills/doc-control-ops/scripts/dc_ops.py audit --no-viewer
```

If you run it from outside the repo, pass `--repo` or set `DOC_CONTROL_REPO`.

Supported commands:

- `audit` — run `run_auditor.py` with optional `--config` and `--no-viewer`.
- `collect` — run `run_collect.py` for Mattermost/Redmine.
- `dev` — run docker compose stack commands (`up/down/restart`).
- `worker` — start `worker` container via docker compose.
- `migrate` — run Django migrations as a separate ops step.
- `export` — run `export_docs.py` (RU → Markdown + registry).
- `google-sync` — sync exported Markdown to Google Docs/Sheets.
- `clean` — remove generated outputs and caches.
- `profile` — offline profiling for audit/graph (no network).
- `quality` — run ruff, ty, Django checks, and pytest.
- `bench` — run real benchmark and store monthly state/reports.
- Bench scenarios are read from `references/bench_scenarios.json`; extend that file when new features are added.

Note: `run_dev.py` is an in-container entrypoint for `web`/`worker`. Host orchestration is done via `docker compose`.

## Safety Notes

- Do not run DB‑mutating commands (`migrate`, `flush`, `collectstatic`) unless explicitly asked.
- Network calls (Mattermost, Redmine, Google, S3, LLMs) must be intentional.
- Keep diffs small; avoid unrelated refactors.

## References

- `references/workflows.md` — step‑by‑step scenarios and exact commands.
- `references/troubleshooting.md` — common failures and how to fix them.