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.
For the general set of documentation objectives, see The 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 | done |
| 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 | done |
| - global metadata | - | @degville | done |
| - go | - | @degville | done |
| - python | - | @degville | done |
| - pre-built binaries | - | @degville | done |
| - autotools/C++ | - | @degville | done |
| - Java | needs bases | @degville | done |
| - Node.js | - | @degville | done |
| - Ruby | - | @degville | done |
| - Rust | - | @degville | done |
| - MOOS | - | @degville | done |
| - ROS | - | @degville | done |
| - ROS 2 | - | @degville | done |
| - base snaps | - | @degville | done |
| - adding parts | - | @degville | done |
| - parts lifecycle | - | @degville | done |
| - build dependencies | - | @degville | done |
| - iterating over a build | - | @degville | done |
| - defining a command | - | @degville | done |
| - choosing a security model | - | @degville | done |
| - troubleshooting (section specific) | - | @degville | done |
| 4. Interfaces | - | @popey | done |
| - networking | - | @popey | done |
| - games | - | @popey | done |
| - desktop | - | @popey | - |
| - common interfaces | - | - | - |
| - full list of interfaces | tweak to fit new structure | - | - |
| - handling versions | - | @popey | - |
| - troubleshooting (section specific) | - | - | - |
| 5. Store upload and optimisation | - | @degville | done |
| - release management | - | @degville | done |
| - metrics | - | @degville | done |
| - troubleshooting (section specific) | - | @degville | - |
To be organised
| Page title | Notes | Who | Status |
|---|---|---|---|
| Restarting services from within snaps (snapctl) | - | - | - |
| Godot | - | - | - |