Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update component documentation #5174

Merged
merged 5 commits into from
Dec 12, 2024
Merged

docs: update component documentation #5174

merged 5 commits into from
Dec 12, 2024

Conversation

mr-cal
Copy link
Collaborator

@mr-cal mr-cal commented Dec 10, 2024 •
edited
Loading

  • Have you followed the guidelines for contributing?
  • Have you signed the CLA?
  • Have you successfully run tox run -m lint?
  • 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)

@mr-cal
docs: update component documentation
7eb67b9 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal requested a review from medubelko December 10, 2024 21:22
medubelko
medubelko requested changes Dec 10, 2024
View reviewed changes
docs/reference/components.rst Outdated Show resolved Hide resolved
docs/reference/components.rst Outdated Show resolved Hide resolved
docs/reference/components.rst Outdated Show resolved Hide resolved
docs/reference/components.rst Outdated Show resolved Hide resolved
docs/reference/components.rst Outdated Show resolved Hide resolved
docs/reference/components.rst Outdated Show resolved Hide resolved
@mr-cal
chore: feedback from PR
b8357ee 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal requested a review from medubelko December 11, 2024 15:44
medubelko
medubelko approved these changes Dec 11, 2024
View reviewed changes
Copy link
Contributor

@medubelko medubelko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mr-cal
chore: feedback from PR
9f9ca29 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal requested a review from mattculler December 12, 2024 14:33
@mr-cal mr-cal added the squash label Dec 12, 2024
@mr-cal mr-cal requested review from sergiusens and removed request for mattculler December 12, 2024 14:34
@mr-cal
docs: link to hooks
f8c13e8 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal
Copy link
Collaborator Author

mr-cal commented Dec 12, 2024

Spread failures unrelated - snaps are randomly failing to download from the store today

@mr-cal mr-cal merged commit f028b3d into main Dec 12, 2024
10 of 13 checks passed
@mr-cal mr-cal mentioned this pull request Dec 12, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@medubelko medubelko medubelko approved these changes

@sergiusens sergiusens sergiusens approved these changes

Assignees
No one assigned
Labels
squash
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update component documentation
3 participants
@mr-cal @sergiusens @medubelko