docs: update component documentation
Metadata
Current evaluation
Merged after two reviewer approvals and passing CI. Updates component documentation by replacing deprecated type test with type standard and adding runtime mounting details, resolving issue 5162.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox run -m lint`?
- [x] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
-----
1. Use ``type: standard`` for the example instead of the undocumented ``type: test``. `test` will be deprecated in the future.
2. Add some documentation on component types and how components are mounted at runtime.
I used some material from https://docs.google.com/document/d/1os0mS6FjZXeE0Y7PX0Znkhcw2jXb9WtpNrUdvA2dLLI/edit. That will eventually be available in snapd's documentation and we will be able to link to for more information on how snapd handles components.
Fixes #5162
(CRAFT-3753)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after two reviewer approvals and passing CI. Updates component documentation by replacing deprecated type test with type standard and adding runtime mounting details, resolving issue 5162. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update replacing undocumented type test with type standard and adding component type and runtime mounting details. Resolves issue 5162. Unrelated spread failures were noted but did not block the merge. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update replacing undocumented type: test with type: standard and adding component type and runtime mounting details. Resolves #5162. Unrelated spread failures were noted but did not block the merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #4904 docs: add explanation, howto, and reference for components | snapcraft | merged | Merged after approval and passing CI checks. Added explanation, how-to, and reference documentation for components, resolving issue #4857. Unrelated test failures were noted but did not block the merge. | |
| #5757 docs: add docs for setting component versions | snapcraft | merged | Merged documentation update adding release notes for component version settings and linking the component how-to to the craftctl guide. Approved by two reviewers and passed all CI checks. | |
| #5179 docs: fix component type in the howto | snapcraft | merged | Merged a documentation fix correcting the component type in docs/howto/code/components-organize/snapcraft.yaml. The change followed up on PR 5174, passed all CI checks, and received approval from three reviewers before being merged. | |
| #1379 docs: fix 'Part properties' typos | craft-parts | merged | Merged documentation update correcting typos and inconsistencies in the 'Part properties' reference. Approved by two reviewers with all CI checks passing. Changes modified three files. | |
| #1055 docs: modify types to be actual variable types | craft-parts | merged | Merged documentation update correcting variable types in the part-properties reference page. Approved by two reviewers, passed CI, and modified one file with 17 additions and 14 deletions. | |
| #1104 docs: update links | craft-parts | merged | Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures. |