canonical/open-documentation-academy

Snapcraft: create how-to documentation for review-tools

Aperta

#6 aperta il 25 gen 2024

Vedi su GitHub
 (6 commenti) (0 reazioni) (1 assegnatario)Python (99 fork)auto 404
help wantedhow-tonewsize 5

Metriche repository

Star
 (119 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Ricerchi lo snap review tools installandolo ed eseguendo il comando snap review su uno snap di esempio. Esplora l'output di aiuto e i modelli di utilizzo comuni. Rivedi la struttura e lo stile della documentazione Snapcraft esistente per allineare la nuova guida pratica. Identifica i problemi comuni con le revisioni degli snap e come risolverli.
Tech stack
shell
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitSnapcraft
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75