-
Notifications
You must be signed in to change notification settings - Fork 81
Open
Labels
diátaxisRevise a document to better conform to its Diátaxis typeRevise a document to better conform to its Diátaxis typeexplanationWrite or update an explanation for a known topicWrite or update an explanation for a known topichelp wantedWe welcome community help with this issueWe welcome community help with this issuehow-toCreate a edit a how-to to achieve a specific taskCreate a edit a how-to to achieve a specific tasksize 2Fix a known documentation issue (size 2/8)Fix a known documentation issue (size 2/8)updateUpdate potentially outdated instructions, commands, or version numbersUpdate potentially outdated instructions, commands, or version numbers
Description
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 typeRevise a document to better conform to its Diátaxis typeexplanationWrite or update an explanation for a known topicWrite or update an explanation for a known topichelp wantedWe welcome community help with this issueWe welcome community help with this issuehow-toCreate a edit a how-to to achieve a specific taskCreate a edit a how-to to achieve a specific tasksize 2Fix a known documentation issue (size 2/8)Fix a known documentation issue (size 2/8)updateUpdate potentially outdated instructions, commands, or version numbersUpdate potentially outdated instructions, commands, or version numbers