Snapcraft build, debug and publishing docs roadmap (page breakdown)


#1

This is a list of pages that need to be written and updated to satisfy the requirements outlined in the Snapcraft build, debug and publishing docs roadmap.

We’re using this page to track updates and to note who is working on what.

  • each row is intended to be a single topic/page in the documentation
  • a page can be small and concise; that’s ok.
  • a page can equally expand to further pages during writing
  • when a page links off to other resources, the structure of the parent page continues according to the roadmap

Where pages are split is an approximation and may change, or pages may be combined (such as combining the various Troubleshooting pages.

See Documentation guidelines for advice on style and formatting.

Page breakdown

Page title Notes Who Status
1. Lifecycle - @degville -
2. Create a checklist - @degville done
- languages / frameworks / build system parts - - done
- toolkits / desktop support (GNOME, KDE, etc.) - - done
- integration (PulseAudio, IPC - - done
- troubleshooting (section specific) - - done
3. From checklist to snapcraft.yaml - @degville in-progress
- global metadata - @degville done
- go - @degville -
- python - @degville -
- cmake - - -
- other plugins - - -
- base snaps - @degville done
- adding parts - @degville done
- build dependencies - @degville done
- making your snap runnable - @degville in-progress
- troubleshooting (section specific) - @degville -
4. Interfaces - @popey in-progress
- networking - @popey -
- games - @popey -
- desktop - @popey -
- common interfaces - - -
- full list of interfaces tweak to fit new structure - -
- handling versions - @popey -
- troubleshooting (section specific) - - -
5. Store upload and optimisation - - -
- publishing to stable - - -
- metrics - - -
- troubleshooting (section specific) - - -

To be organised

Page title Notes Who Status
Restarting services from within snaps (snapctl) - - -
Godot - - -

#2

@popey I’ve put your name against quite a few of the pages above. These are the ones I think make the most of your special skills, but please don’t think you need to do them all. Even one would help massively. Thank you!