Skip to content

Snap: improve interface management documentation #8

@degville

Description

@degville

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.

Metadata

Metadata

Assignees

Labels

diátaxisRevise a document to better conform to its Diátaxis typeexplanationWrite or update an explanation for a known topichelp wantedWe welcome community help with this issuehow-toCreate a edit a how-to to achieve a specific tasksize 2Fix a known documentation issue (size 2/8)updateUpdate potentially outdated instructions, commands, or version numbers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions