49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
# Ansible D&D Development Workspace
|
|
|
|
This repository coordinates development of the Ansible roles and collection
|
|
used to deploy the D&D transcript-processing pipeline. The application and
|
|
Ansible projects remain independent Git repositories; this repository tracks
|
|
only workspace documentation, planning, and shared development utilities.
|
|
|
|
## Start Here
|
|
|
|
- [`AGENTS.md`](AGENTS.md) describes repository boundaries and routes each
|
|
kind of work to its required policy documents.
|
|
- [`workspace.yml`](workspace.yml) inventories the repositories used during
|
|
development.
|
|
- [`docs/roadmap/mvp.md`](docs/roadmap/mvp.md) records settled MVP decisions
|
|
and open design work.
|
|
- [`docs/roadmap/features/`](docs/roadmap/features/) contains durable feature
|
|
roadmaps for selected units of work.
|
|
- [`docs/status.md`](docs/status.md) records current cross-repository progress.
|
|
- [`docs/roadmap/implementation.md`](docs/roadmap/implementation.md), when
|
|
present, is the single active out-of-band implementation plan.
|
|
- [`docs/roadmap/implementation-template.md`](docs/roadmap/implementation-template.md)
|
|
defines its staged format.
|
|
|
|
Run `./scripts/status` to see the branch and working-tree state of every
|
|
repository in the workspace manifest.
|
|
|
|
## Development Tooling
|
|
|
|
Create the shared workspace environment on Ubuntu 26.04 with:
|
|
|
|
```sh
|
|
sudo apt-get install python3-venv
|
|
python3 -m venv .venv
|
|
.venv/bin/python -m pip install --upgrade pip
|
|
.venv/bin/python -m pip install -r requirements-dev.txt
|
|
```
|
|
|
|
Either activate it with `source .venv/bin/activate` or invoke tools directly,
|
|
for example `.venv/bin/ansible-playbook` and `.venv/bin/ansible-lint`.
|
|
Dependency upgrades are deliberate changes to `requirements-dev.txt`; do not
|
|
install workspace development packages into the system Python environment.
|
|
|
|
## Repository Boundaries
|
|
|
|
The directories ignored by this repository are intentional nested Git working
|
|
trees. Run Git commands from within the repository whose history should be
|
|
affected. A commit in this control repository never includes changes from an
|
|
application, role, collection, or proof-of-concept repository.
|