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:

:white_medium_square: Snapcraft (rewritten around the use of bases)

  • :white_check_mark: Overview
  • :white_check_mark: Installation (in a central place)
  • :white_medium_square: Command syntax
  • :white_medium_square: Broaden parts documentation
  • :white_check_mark: Bases
  • :white_medium_square: Publishing
  • :white_medium_square: Migrating from remote parts/pre-base snapcraft.yaml
  • :white_medium_square: Confinement
  • :white_medium_square: Adding and working with interfaces
  • :white_medium_square: Using plugins
  • :white_check_mark: Document filesets
  • :white_medium_square: Tracking down dependencies
  • :white_check_mark: Working with Multipass (Snapcraft v3)
  • :white_medium_square: Re-work LXD advantages alongside Multipass (Snapcraft v3)
  • :white_medium_square: Re-work Docker to emphasise its use with snap CI (Snapcraft v3)
  • :white_medium_square: Build override examples
  • :white_medium_square: Environment variables
  • :white_medium_square: Scriptlets
  • :white_medium_square: Troubleshooting
    • :white_medium_square: Using snappy-debug.security
    • :white_medium_square: Using snapctl

:white_check_mark: Add docs search to docs.snapcraft.io
:white_medium_square: Update snapcraft.yaml to new format with fixes
:white_medium_square: Tackle the snap.yaml and snapcraft.yaml ambiguity
:white_medium_square: docs.snapcraft.com landing page

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

:white_medium_square: Using in-development features
:white_medium_square: Improve contribution guidelines

Style and consistency reviews

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

Upcoming

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

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.