canonical/open-documentation-academy

Snapcraft: create how-to documentation for review-tools

Open

#6 opened on Jan 25, 2024

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Python (99 forks)auto 404
help wantedhow-tonewsize 5

Repository metrics

Stars
 (119 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Research the review tools snap by installing it and running the snap review command on a sample snap. Explore its help output and common usage patterns. Review existing Snapcraft documentation structure and style to align the new how to guide. Identify common issues with snap reviews and how to fix them.
Tech stack
shell
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitSnapcraft
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75