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

feat: Add RT apps snap packaging to the existing tutorial #99

Open
wants to merge 68 commits into
base: main
Choose a base branch
from
Open

feat: Add RT apps snap packaging to the existing tutorial #99

wants to merge 68 commits into from

Conversation

locnnil
Copy link
Contributor

@locnnil locnnil commented Mar 25, 2025

No description provided.

@locnnil locnnil marked this pull request as ready for review March 28, 2025 01:55
@locnnil locnnil force-pushed the IENG-1447-snapping-rt-app branch from 6704caa to 027de03 Compare March 28, 2025 01:59
@locnnil locnnil requested a review from farshidtz March 28, 2025 02:00
@farshidtz farshidtz requested review from jpm-canonical and removed request for jpm-canonical March 28, 2025 09:10
@locnnil locnnil requested a review from farshidtz March 28, 2025 10:08
jpm-canonical
jpm-canonical requested changes Mar 28, 2025
View reviewed changes
@locnnil locnnil force-pushed the IENG-1447-snapping-rt-app branch from 394baa3 to 2eaaec8 Compare March 28, 2025 14:27
@locnnil locnnil requested a review from jpm-canonical March 28, 2025 14:27
farshidtz
farshidtz requested changes Mar 31, 2025
View reviewed changes
Copy link
Member

@farshidtz farshidtz left a comment

Choose a reason for hiding this comment

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

Thanks. Very good addition to the tutorial.
I have several improvement suggestions for the content.

locnnil and others added 19 commits March 31, 2025 10:42
@locnnil
wip: snapping rt app
dc8c3aa 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
refact: simplify environment setup instructions
00a9cb6 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: add snapd to custom_wordlist
ca7a1ec 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: add Makefile
7653403 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
chore: add squashfs to custom_wordlist
3e90cca 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
wip: structural
53c7f37 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
chore(Makefile): ignore warning during build
ea6114d 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat!: drop console output for snap version
8483cae 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: complete defining snap parts
ab46033 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: add snapcraft.yaml file
089c943 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: final snapcraft.yaml file
9ac818e 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: add final textual components
d32843b 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
refact: grammar improvements
ab6367c 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
chore: add technical words to custom_wordlist
973b0fe 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil @jpm-canonical
many: grammar fixes and rewordings
bf93091 
Co-authored-by: JP Meijers <[email protected]>
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
refact: codify snap name and snapcraft.yaml
a3449db 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
chore: change file name
3e37271 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil @farshidtz
refact: complement command info
589fc3d 
Co-authored-by: Farshid Tavakolizadeh <[email protected]>
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil @farshidtz
refact: reword sentence and add additional context
345f732 
Co-authored-by: Farshid Tavakolizadeh <[email protected]>
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
Copy link
Contributor Author

locnnil commented Apr 4, 2025 •
edited
Loading

The link check failure on accessing those:

Seems to be related to this:

image

git.kernel.org started to use anubis from Techaro to stop AI crawlers.
This is causing a URL redirection, making the anchor checker to fail.

I've added an extra rule for git.kernel.org here: 520c46a

@locnnil locnnil mentioned this pull request Apr 4, 2025
Merged
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
AnneCYH
AnneCYH reviewed Apr 7, 2025
View reviewed changes
docs/tutorial/7-snapping.md
:language: yaml
```

A good next step is to distribute this snap via a store:
Copy link
Collaborator

Choose a reason for hiding this comment

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

this is helpful! the tutorial provides a next step of what the user can do next.

AnneCYH
AnneCYH requested changes Apr 7, 2025
View reviewed changes
Copy link
Collaborator

@AnneCYH AnneCYH left a comment

Choose a reason for hiding this comment

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

hi @locnnil !

Thanks for working on this doc.
I made quite a few suggestions because I think the doc is focusing too much on explanation for snaps / snaps packaging; the explanations are not specific to RTU or supplement information about the real-time app. We should minimize these snap-related explanations unless absolutely needed and leave the rest to the links that are included to Snapcraft / Snap docs.

Thanks.

locnnil and others added 13 commits April 7, 2025 07:47
@locnnil
refact: capitalize snapcraft to be consistant
8a753fc 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: make headings action orientated using verbs
b5a4715 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil @AnneCYH
feat: use {kbd} syntax to Tab
a65d4b6 
Co-authored-by: AnneCYH <[email protected]>
@locnnil
feat: use :file: role for snapcraft.yaml
51bcc87 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: improve sentence
a5885f4 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil @AnneCYH
feat!: drop snap explanation regarding snapcraft build
2d5e1dd 
Co-authored-by: AnneCYH <[email protected]>
@locnnil
feat: drop fail install cmd and add admonition note
41b3216 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
chore: add devmode to be ignored by spell check
9d29c98 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: add context on why to inspect the .snap file
a8ca5d4 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil @AnneCYH
feat: shrink context on snap sandboxing and security
b2d0c92 
Co-authored-by: AnneCYH <[email protected]>
@locnnil
feat: turn alternative confine path into tip
72604fa 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
fix: heading and drop new lines
6334e28 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil
feat: change conclusion to H2
d4747d7 
Signed-off-by: Lincoln Wallace <[email protected]>
@locnnil locnnil requested a review from AnneCYH April 7, 2025 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@farshidtz farshidtz farshidtz approved these changes

@jpm-canonical jpm-canonical Awaiting requested review from jpm-canonical

@AnneCYH AnneCYH Awaiting requested review from AnneCYH

Requested changes must be addressed to merge this pull request.

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

Successfully merging this pull request may close these issues.
4 participants
@locnnil @farshidtz @AnneCYH @jpm-canonical