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 Contribute to our documentation for further details.


Snapcraft

General items

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

snapd

general

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

upcoming this cycle

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

Bugs

General documentation targets

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

Style and consistency reviews

Proposed

  • :white_medium_square: 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

Snapcraft

General items

snapd

general

upcoming this cycle

General

Style and consistency reviews

Bugs


Last updated 1 year, 8 months ago.