docs: update component documentation
Metadata
Current evaluation
Merged PR #5174 in commit f028b3d79 documented component types and runtime mounting and replaced the deprecated test type example with standard, fixing #5162.
Resolution: closed resolved
Reason: The approved documentation PR was merged as commit f028b3d79. It documents standard and kernel-modules components, explains runtime mounting, and explicitly fixes #5162.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #5174 in commit f028b3d79 documented component types and runtime mounting and replaced the deprecated test type example with standard, fixing #5162. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5174 in commit f028b3d79, documenting component types and runtime mounting and switching the example to type: standard; fixes #5162. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #5174 (f028b3d79): documented component types and runtime mounting and replaced the undocumented type: test example with type: standard, resolving #5162. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #5174 (commit f028b3d79): updated component docs to use type: standard and explain component types and runtime mounting, resolving #5162. | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Related To:
snapcraft#5162
(confidence 100%)
This component documentation gap was the issue explicitly fixed by PR #5174.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5162 Update component documentation | snapcraft | closed | Component types test, standard, and kernel-modules were documented, and the how-to was updated to use standard, resolving the request in #5174 and commit 155753d52. | |
| #4904 docs: add explanation, howto, and reference for components | snapcraft | merged | Merged PR #4904 in commit 011dd11df, adding component explanation, how-to, and reference documentation; it fixes #4857. Unrelated spread-test failures were moved to #4910. | |
| #4857 Write components documentation | snapcraft | closed | Component explanation, how-to, and reference documentation was added and merged in PR #4904 (commit 011dd11df), resolving #4857. | |
| #5179 docs: fix component type in the howto | snapcraft | merged | Merged PR #5179 in commit 155753d52, correcting the component type in the organize-howto snapcraft.yaml example missed by #5174. |