anthony.wen
274b920b40
Restructure the ATVM folder to separate executable scripts from workflow documentation and long-form environment reference material. Move setup and automation scripts into scripts/, move setup and automation guides into docs/, add top-level README and workflow conventions, and organize durable environment details into inventory/ while preserving the original long-form ATVM notes under archive/imported-notes/. Update internal documentation paths to match the new layout and remove the archived Zone.Identifier metadata file.
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# ATVM Workspace
|
|
|
|
This folder contains the ATVM setup workflow, ATVM Cypress automation workflow, and the lab inventory/reference material used to operate them.
|
|
|
|
## Start Here
|
|
- Setup/bootstrap workflow:
|
|
- `docs/setup/guide.md`
|
|
- ATVM Cypress automation workflow:
|
|
- `docs/automation/guide.md`
|
|
- Shared maintenance conventions:
|
|
- `docs/workflow/conventions.md`
|
|
- Environment inventory and credentials:
|
|
- `inventory/overview.md`
|
|
|
|
## Layout
|
|
- `scripts/`
|
|
- executable scripts used by setup/bootstrap
|
|
- `docs/setup/`
|
|
- setup procedure and setup run learnings
|
|
- `docs/automation/`
|
|
- automation procedure, reusable examples, and automation run learnings
|
|
- `docs/workflow/`
|
|
- conventions for how this workspace is structured and maintained
|
|
- `inventory/`
|
|
- environment inventory, credentials, reserved IPs, and reference maps
|
|
- `archive/imported-notes/`
|
|
- preserved original long-form notes that were reorganized into the current structure
|
|
|
|
## Practical Guidance
|
|
- Use `guide.md` files for authoritative workflow behavior.
|
|
- Use `examples.md` for reusable command patterns only.
|
|
- Use `run-learnings.md` only when a run produced a new lasting lesson.
|
|
- Use `inventory/` for persistent environment information such as hosts, credentials, and IP assignments.
|
|
- Use `archive/imported-notes/` when you need the original full historical notes in their original layout.
|