search

canonical / open-documentation-academy

Learn open-source software documentation skills with Canonical
https://canonical.com/documentation/open-documentation-academy
Apache License 2.0
72 stars 43 forks source link

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

Open degville opened 10 months ago

degville commented 10 months ago

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.

tawandamoyo commented 8 months ago

I would like to work on this

degville commented 7 months ago

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 commented 7 months ago

Hello @degville , thanks. Working on this!

tawandamoyo commented 4 months ago

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 commented 4 months ago

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

dilyn-corner commented 2 months ago

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