← Back to issue list

docs: Clean and document new fields

View original Github issue

Metadata

Project
imagecraft
Number
#109
Type
pull request
State
merged
Author
upils
Labels
—
Created
Updated
Closed

Current evaluation

Merged as commit 5b05ae3 ("docs: Clean and document new fields (#109)"): documented overlay, volumes and other common imagecraft.yaml fields, removed ubuntu-image references, and added a more representative example (+258/-530 across 22 files).

Resolution: closed resolved

Reason: The PR itself was merged into main as commit 5b05ae3 after approval by two reviewers, delivering the four documentation items listed in its description. The remaining review thread was a non-blocking follow-up: maintainer upils asked medubelko in March 2025 whether the Parts properties page direction worked out, and medubelko restored the page while noting a Pydantic model extension would later serve project file references for all apps.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [ ] Have you followed the guidelines for contributing? - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint && make test`? --- - add documentation on overlay - clean references to `ubuntu-image` - document the `volumes` section of the `imagecraft.yaml` (and other common fields) - add a better `imagecraft.yaml` example (will evolve in future PRs but is now closer to what imagecraft expects)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged as commit 5b05ae3 ("docs: Clean and document new fields (#109)"): documented overlay, volumes and other common imagecraft.yaml fields, removed ubuntu-image references, and added a more representative example (+258/-530 across 22 files).
stealth/space-bunny-alpha — closed resolved Merged in canonical/imagecraft#109, updating imagecraft.yaml documentation for overlay, volumes, and common fields, cleaning ubuntu-image references, and adding a more representative example.
qwen/qwen3.6-35b-a3b — — Merged documentation updates for imagecraft.yaml covering overlay and volumes fields, cleaned ubuntu-image references, and an improved example. Approved by two reviewers, passed CI, and modified 22 files.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates for imagecraft.yaml covering overlay, volumes, ubuntu-image references, and an improved example. The reviewer restored the Part properties page, noting an upcoming Pydantic extension will handle project file references.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/imagecraft#110 (confidence 78%)

    Committed immediately after 5b05ae3 as 'feat: Support overlay (#110)'; this PR documents that overlay support, though the feature landed after the docs work.

  • Related To: canonical/imagecraft#189 (confidence 62%)

    Later 'docs: clean up imagecraft.yaml' commit bfe4f70 continuing the same reference-page maintenance this PR began.

  • Related To: canonical/imagecraft#245 (confidence 55%)

    Successive docs: clean up 'imagecraft.yaml' commit 3f819e5, showing the example added in this PR kept being revised in later releases.

Related issues

Issue Project State Summary Similarity
#173 docs: update 'imagecraft.yaml' imagecraft merged Merged the imagecraft.yaml documentation update, reordering part keys and documenting organize, in PR #173 (commit d46f752).
71%
#156 docs: update yaml reference imagecraft merged Merged PR #156 as commit 1dbd410, automating the imagecraft.yaml reference with Kitbash and field docstrings added in PR #153.
70%