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.

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

Snapcraft: create how-to documentation for review-tools #6

Open
degville opened this issue Jan 25, 2024 · 6 comments
Open

Snapcraft: create how-to documentation for review-tools #6

degville opened this issue Jan 25, 2024 · 6 comments
Assignees
Labels
help wanted We welcome community help with this issue how-to Create a edit a how-to to achieve a specific task new Adding new or missing documentation for a specific tool, feature, or function. size 5 Fix a known documentation issue (size 5/8)

Comments

@degville
Copy link
Collaborator

Write a how-to guide on using review-tools to check a snap is consistent and secure.

Background

The review-tool command can be used to test whether a freshly built snap will pass Store tests permitting the snap to be published. The Store runs reviews tools whenever a new snap is uploaded. The following is a common command, for example:

review-tools.snap-review cameractrls_0.5.6-0-gd8136d1_amd64.snap 

This how-to should cover how to install the review-tools snap, how its most important functions are accessed, and how some of the most common problems could be mitigated.

Prerequisites

You will need some experience building snaps.

See also Contribute to our documentation.

@degville degville added new Adding new or missing documentation for a specific tool, feature, or function. help wanted We welcome community help with this issue size 5 Fix a known documentation issue (size 5/8) how-to Create a edit a how-to to achieve a specific task labels Jan 25, 2024
@tawandamoyo
Copy link

I would like to work on this

@degville
Copy link
Collaborator Author

Hello @tawandamoyo! Sorry for the delay getting back to you - I was away last week. And thanks so much for your interest in this. I'm going to assign the task to you, so please feel free to take a closer look.

@tawandamoyo
Copy link

Hello @degville , thanks. Working on this!

@tawandamoyo
Copy link

tawandamoyo commented Jul 8, 2024

Hi @degville ,

I have a draft ready but would welcome your eye, and especially suggestions particularly on the other commands/errors/warnings etc.

I have a draft PR that I'd be happy to improve.

Thanks

@degville
Copy link
Collaborator Author

degville commented Jul 9, 2024

@tawandamoyo Thank you so much for this - I'll take a look.

@dilyn-corner
Copy link

Provided some feedback -- I'm selfish and want this 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We welcome community help with this issue how-to Create a edit a how-to to achieve a specific task new Adding new or missing documentation for a specific tool, feature, or function. size 5 Fix a known documentation issue (size 5/8)
Projects
None yet
Development

No branches or pull requests

3 participants