canonical / pebble

Pebble is a lightweight Linux service manager with layered configuration and an HTTP API.
https://canonical-pebble.readthedocs-hosted.com/
GNU General Public License v3.0
145 stars 54 forks source link

docs: remove howtos and add references #438

Closed IronCore864 closed 2 months ago

IronCore864 commented 3 months ago

Remove most how-to docs since they are more like references. Create reference docs.

Changes:

Preview: https://canonical-pebble--438.com.readthedocs.build/en/438/reference/

benhoyt commented 3 months ago

I haven't reviewed this in depth. I have a couple of thoughts:

Tutorial
How-to guides
Explanation
Reference
  Commands
    Start
    Stop
    Run
    ...
  Layers
  Notices
  ...

Let's chat about the structure of this with Anne when you're back, and we can go from there.

IronCore864 commented 2 months ago

The latest commit contains the two changes:

Preview: https://canonical-pebble--438.com.readthedocs.build/en/438/reference/cli-commands/cli-commands/

IronCore864 commented 2 months ago

I have removed the "index" title from the CLI command page and resolved previous comments. Anne's OK with merging this one before coming up with a solution for automated reference doc generation. Please take a final review and merge @benhoyt @AnneCYH.

benhoyt commented 2 months ago

I'm happy to merge this in the name of incremental progress. However, the command documentation is a bit scattered right now, so I think there's a bunch of reorganisation that needs to be done for future work. In particular, only some of the commands are under "CLI Commands", and some are under "Changes and Tasks" (changes, tasks), some are under "Notices" (notice, notices, notify), and some under "Use Pebble in Containers" (exec, ls, mkdir, rm, push, pull).

I think the next step should be automating the command help generation, and that will put all the CLI commands under "CLI Commands".

Then we can remove the commands that are in the other subsections. But I think some content should also move to How-tos, for example: "How to use Pebble in containers" (exec, ls, etc), "How to use Pebble notices". Maybe "Changes and Tasks" should go to Explanation, as it's more of an implementation detail. Those pages can link to the CLI commands for full details, of course.

@IronCore864 Perhaps you could propose a draft structure (not a PR, just a table of contents / outline in a GitHub issue) and we can discuss with Anne before we go further?