diff --git a/docs/reference/index.md b/docs/reference/index.md index e9dd9af29..9318de16f 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -2,100 +2,87 @@ These guides provide technical information about Pebble. - -## Layers - -Pebble configuration is defined as a stack of "layers". +% COMMENT: This toctree is for the navigation sidebar only +% Use an alphabetical listing of pages in the toctree +% For each page, make sure there's also a link in a section below ```{toctree} +:hidden: :titlesonly: :maxdepth: 1 +Changes and tasks +CLI commands +Health checks +Identities Layers Layer specification +Log forwarding +Notices +Pebble in containers +Service auto-restart ``` -## Pebble commands +% COMMENT: The first few pages are presented in a more logical reading order -The `pebble` command has several subcommands. -```{toctree} -:titlesonly: -:maxdepth: 1 +## Layers -CLI Commands -``` +Pebble configuration is defined as a stack of "layers". +* [Layers](layer-specification) +* [Layer specification](layer-specification) -## Pebble in containers -When the Pebble daemon is running inside a remote system (for example, a separate container), you can manage the remote system using subcommands on the Pebble client. +## Pebble commands -```{toctree} -:titlesonly: -:maxdepth: 1 +The `pebble` command has several subcommands. -Use Pebble in containers -``` +* [CLI commands](cli-commands/cli-commands) -## Access to the API +## Pebble in containers -You can set up named "identities" to control access to the API. +When the Pebble daemon is running inside a remote system (for example, a separate container), you can manage the remote system using subcommands on the Pebble client. -```{toctree} -:titlesonly: -:maxdepth: 1 - -Identities -``` +* [Pebble in containers](pebble-in-containers) ## Service failures Pebble provides two ways to automatically restart services when they fail. Auto-restart is based on exit codes from services. Health checks are a more sophisticated way to test and report the availability of services. -```{toctree} -:titlesonly: -:maxdepth: 1 +* [Service auto-restart](service-auto-restart) +* [Health checks](health-checks) -Service auto-restart -Health checks -``` + +% COMMENT: After this point, match the alphabetical listing of pages ## Changes and tasks Pebble tracks system changes as "tasks" grouped into "change" objects. -```{toctree} -:titlesonly: -:maxdepth: 1 - -Changes and tasks -``` - +* [Changes and tasks](changes-and-tasks) -## Notices -Pebble records events as "notices". In addition to the built-in notices, clients can report custom notices. +## Identities -```{toctree} -:titlesonly: -:maxdepth: 1 +You can set up named "identities" to control access to the API. -Notices -``` +* [Identities](identities) ## Log forwarding Pebble can send service logs to a Loki server. -```{toctree} -:titlesonly: -:maxdepth: 1 +* [Log forwarding](log-forwarding) -Log forwarding -``` + +## Notices + +Pebble records events as "notices". In addition to the built-in notices, clients can report custom notices. + +* [Notices](notices)