Documentation roadmap

This is a list of the documentation issues and documents that we (the snap team) are currently working to improve. It isn’t necessarily a list of documents we want to write, but it is a list of subjects we know need attention or need clearer and more concise documentation.

Our documentation is a community effort, published via this forum. We warmly welcome community contributions, suggestions, fixes and constructive criticism. See Documentation guidelines for further details.

Snapcraft
- General items
snapd
General documentation targets
Style and consistency
Proposed
Archived

Snapcraft

General items

Restructure Snapcraft docs navigation to use Diátaxis
Create a strategy to audit Snapcraft docs; updating and editing for consistency with Diátaxis
Pull in and update out-dated tutorials from /tutorials
Edit and revise platform Quickstart guides
Snap key signing
User details/SSSD support from snaps
document defaulting to $HOME
Scriptlets
Tackle the snap.yaml and snapcraft.yaml ambiguity
Document GitHub actions for building
Add a simple packaging bash script example
Add a Python/GTK application example
Use of bind or symlinks in Layout
Troubleshooting
- Using snappy-debug.security
- Using debug strace

snapd

general

Restructure Snap docs navigation to use Diátaxis
Create a strategy to audit Snap docs; updating and editing for consistency with Diátaxis
port, refactor and split API REST docs (and link back)
Using in-development features
Bash completion
$HOME/snap is the writable area for snaps
Document preseeding (won’t work with LXD)
Differentiate system options for Ubuntu Core
Document hook execution ordering
Improve dbus interface documentation

upcoming this cycle

Update: Quota docs to include service sub-groups
snapctl model (in 2.57)

Bugs

General documentation targets

Enable and migrate to foldable navigation
Convert Snap docs to use the Diátaxis framework
Convert Snapcraft docs to use the Diátaxis framework
Split interface docs into user and developer sections
Investigate automatic backup/snapshot of docs to a git repository

Style and consistency reviews

Using Tracks
Architectures
Make better use of, and update, Documentation Drive Hit List

Proposed

Remove dollar signs at the beginning of the shell prompts (to be consistent with other Canonical docs and the Ubuntu wiki)

Archived

Completed documentation tasks