search

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: a new getting started tutorial for pebble #421

Closed IronCore864 closed 3 months ago

IronCore864 commented 4 months ago

Create a new getting started tutorial documentation for Pebble.

It contains only basic installation and operations, not all features.

AnneCYH commented 3 months ago

Hi @benhoyt , @IronCore864 ,

I left a bunch of general comments for the tutorial. I think overall it's in the right direction! It covers the basics of using Pebble and should be easily repeatable by anyone going through the tutorial.

I did have some suggestions to make but the comments just became too overwhelming so I forked Tiexin's repo and created a PR from there. https://github.com/IronCore864/pebble/pull/1

Please do review and let me know your thoughts.

Thanks.

IronCore864 commented 3 months ago

Thanks @AnneCYH for the very detailed review. After discussion, I fixed most of these comments. Please preview here: https://canonical-pebble--421.com.readthedocs.build/en/421/tutorial/getting-started/

To my eyes, it looks a whole lot better now :)