-
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
TITLE: 📖 Auto-Generate Reference Documentation for ENV and ARG Variables
BODY:
Summary
The audit recommends generating a machine-readable reference for:
- All
ARGbuild parameters - All
ENVruntime variables - Their descriptions (where available)
UBI includes dozens of variables and the reference is currently manually maintained.
Required Implementation
- Write a script (Python or Node) to parse Dockerfiles
- Extract:
- ARG names
- ENV names
- Default values
- Generate markdown or JSON docs
- Publish to docs/reference/environment.md
Acceptance Criteria
- Auto-generated docs exist and match Dockerfile definitions
- Running script updates docs without manual editing
Labels
documentation, automation, developer-experience, medium-priority
Copilot