Snap command usage page is incomplete

Bug #1781793 reported by ellie
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Snappy
Invalid
Undecided
Unassigned

Bug Description

I suggest that the "snap" command usage page https://docs.snapcraft.io/core/usage should be layed out differently. Right now it is written as a tutorial with commands hidden inside the sections, but instead I suggest it should be written as a command reference with details listed for each command.
I was trying to start a snap packaged service.

Googling `ubuntu start snap service` one gets to:

1. https://tutorials.ubuntu.com/tutorial/basic-snap-usage (which people who just want a proper reference to glance at will run away from),

2. https://docs.snapcraft.io/core/usage which SOUNDS like a reference but is incomplete and isn't quite,

3. https://forum.snapcraft.io/t/support-for-snapctl-stop-start-restart-services/1908 which is highly misleading and led me to wasting half an hour with the wrong tool. (and file invalid tickets here in the process)

This wouldn't have been an issue if there was an obvious reference of the tool that actually covers ALL usage in the documentation, instead of also being somewhat tutorial-style. It's not wrong having a tutorial, but your obvious main docs link for the "snap" tool should have a very easy to find, very obvious complete reference link, not just a tutorial'ish incomplete article where one needs to dig for the relevant commands.

Revision history for this message
ellie (et1234567) wrote :

Oops, today I'm low on attention span, apparently. The reference link is there, right in the first section. >.> never mind me

Changed in snappy:
status: New → Invalid
Revision history for this message
ellie (et1234567) wrote :

Maybe it would be worth making it a bit more standing out, maybe? Unless I'm the only one that read over it being a bit hidden in the word "here" in that first paragraph.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.