← Back to issue list

docs: rockcraft.yaml reference

View original Github issue

Metadata

Project
rockcraft
Number
#297
Type
issue
State
closed
Author
shipperizer
Labels
Created
Updated
Closed

Current evaluation

Closed without fixing. Maintainer directed users to craft-parts documentation for the organize field, noting plans to integrate those docs into the rockcraft reference later.

Suggested action:

No scores available.

Issue body

### Bug Description Missing reference for the `organize` field in the `rockcraft.yaml` The field [here](https://github.com/canonical/prometheus-rock/blob/main/rockcraft.yaml#L38) is not really documented ### To Reproduce Click on the "here" hyperlink ### Environment all ### rockcraft.yaml ```shell See link ``` ### Relevant log output ```shell See link ```

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Closed without fixing. Maintainer directed users to craft-parts documentation for the organize field, noting plans to integrate those docs into the rockcraft reference later.
qwen/qwen3.6-35b-a3b Closed. Maintainers clarified the organize field originates from craft-parts and directed users to the external craft-parts reference. Internal documentation integration is planned.
qwen/qwen3.6-35b-a3b Documentation gap for the organize field in rockcraft.yaml acknowledged. Maintainer directed users to craft-parts docs as a temporary reference, noting internal documentation integration is in progress. Issue closed without immediate fix.
qwen3.6-35b-a3b-mtp-q6 Closed. Clarified that the organize field is defined by the upstream craft-parts library. Users are directed to craft-parts documentation as a temporary solution, with plans to integrate it into the official reference later.
qwen3.6-35b-a3b-mtp-q6 Closed. Maintainer clarified the organize field is inherited from craft-parts, provided a link to its official docs, and noted plans to integrate that documentation into the project's reference.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#289 docs: expand rockcraft.yaml reference rockcraft merged Merged after three reviewers approved, the PR reorganized the documentation reference section and expanded the rockcraft.yaml reference guide, modifying 7 files.
77%
#680 doc: missing overlay info in rockcraft.yaml reference rockcraft closed Closed as outdated. The missing overlay step reference was already documented in the official Rockcraft reference. Maintainer @asanvaq confirmed the documentation exists and closed the issue without further action.
75%
#1051 docs: TYPE YOUR QUESTION HERE rockcraft closed Broken documentation link fixed. Contributor reported a 404 redirect for Rockcraft docs. Maintainer updated the URL to the correct stable path and closed the issue.
72%
#512 Document `overlay-packages` rockcraft open Docs gap: overlay-packages missing from Rockcraft part_properties reference. The referenced page now redirects to rockcraft.yaml, which documents overlay parameters via an included craft-parts fragment, so the gap is likely resolved. No maintainer activity in 263 days.
72%