The docs roadmap


#1

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.

Loosely ordered by priority:

Snapcraft

  • :white_check_mark: Overview
  • :white_check_mark: Installation (in a central place)
  • :white_check_mark: Bases
  • :white_check_mark: Document filesets
  • :white_check_mark: Working with Multipass (Snapcraft v3)
  • :white_check_mark: Debugging builds: snapcraft --debug
  • :white_check_mark: Publishing
  • :white_check_mark: deprecate cleanbuild. See also SNAPCRAFT_BUILD_ENVIRONMENT.
  • :white_check_mark: Re-work LXD advantages alongside Multipass (Snapcraft v3)
  • :white_check_mark: macOS brew snapcraft and multipass overview
  • :white_check_mark: Update snapcraft.yaml to new format with fixes
  • :white_check_mark: Replace snap with snapd version references in interface docs
  • :white_check_mark: Edit and add to outline Extracting information from sources in snapcraft parts
  • :white_check_mark: update non-table formatting of snapcraft.yaml reference pages
  • :white_check_mark: sorted snapcraft.yaml reference pages into alphabetical order
  • :white_medium_square: add missing adopt-info and related keys to references
  • :white_medium_square: update Layers doc to make its use-case/examples clear
  • :white_medium_square: Environment variables
  • :white_medium_square: Debugging builds: snapcraft --shell
  • :white_medium_square: Snap key signing
  • :white_medium_square: Command syntax (esp. snapcraft clean)
  • :white_medium_square: Need documentation on assumes
  • :white_medium_square: Broaden parts documentation
  • :white_medium_square: Update snapcraft walkthroughs to use bases
  • :white_medium_square: Migrating from remote parts/pre-base snapcraft.yaml
  • :white_medium_square: Adding and working with interfaces
  • :white_medium_square: Using plugins
  • :white_medium_square: Tackle the snap.yaml and snapcraft.yaml ambiguity
  • :white_medium_square: Tracking down dependencies
  • :white_medium_square: Re-work Docker to emphasise its use with snap CI (Snapcraft v3)
  • :white_medium_square: Build override examples
  • :white_medium_square: Scriptlets
  • :white_medium_square: update Debugging Building Snaps for Snapcraft 3 (there is no prime/)
  • :white_medium_square: Glam up your Store page (see Publishing missing)
  • :white_medium_square: Store metrics and reviewing progress
  • :white_medium_square: Troubleshooting
    • :white_medium_square: Using snappy-debug.security
    • :white_medium_square: Using snapctl

snapd

Upcoming this cycle

:white_medium_square: snapd: Hotplug documentation
:white_check_mark: snapd: Snapshot documentation
:white_medium_square: snapd: Epoch documentation

General

:white_check_mark: Add docs search to docs.snapcraft.io
:white_check_mark: docs.snapcraft.com landing page

  • :white_check_mark: Replace boiler-plate intro
  • :white_check_mark: Create a simple matrix of doc locations to visit

:white_medium_square: Improve contribution guidelines

Style and consistency reviews

:white_medium_square: Using Tracks
:white_check_mark: Snap confinement
:white_medium_square: Architectures
:white_medium_square: Make better use of, and update, Documentation Drive Hit List

Bugs

:white_medium_square: Search for snapcraft_arch_triplet has no results (should be Environment variables that Snapcraft exposes). Test it.
:white_check_mark: missing Xubuntu, Kubuntu and Lubuntu snap install docs (plus mention generic flavours)

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)


#2

Search has been added to docs.snapcraft.io. It appears as a search field above the documentation:

Screenshot_20181205_113350

Results are currently delivered via siteSearch on ubuntu.com (eg. https://www.ubuntu.com/search?siteSearch=docs.snapcraft.io&q=filesets), but this mechanism, implementation and design may change.