canonical/open-documentation-academy

Snap: improve interface management documentation

オープン

#8 opened on 2024/01/25

 (9 件のコメント) (0 件のリアクション) (1 人の担当者)Python (99 件のフォーク)auto 404
diátaxisexplanationhelp wantedhow-tosize 2update

Repository metrics

Stars
 (119 個のスター)
PR merge metrics
 (PR metrics pending)

説明

The current interface management documentation isn't as a how-to, and isn't clean, clear, or as simple as it could be.

This task is to improve this documentation to make it easier to understand, to make it task-oriented and to either remove any superfluous details, or move them to the explanation section:

How-to: https://snapcraft.io/docs/interface-management

Explanation: https://snapcraft.io/docs/interfaces

Background

Snaps use plugs and slots to allow access to system resources, but the terminology isn't easy to understand for a general desktop audience. This problem is repeated throughout the snap-related documentation.

Prerequisites

You will need some experience using snaps and working with connections and interfaces.

See also Contribute to our documentation.

コントリビューターガイド