chore: refactor

canonical · Jul 25, 2024 · 76ecbb9 · 76ecbb9
1 parent ae7768c
commit 76ecbb9
Show file tree

Hide file tree

Showing 24 changed files with 24 additions and 24 deletions.
diff --git a/docs/generate_cmd_doc.py b/docs/generate_cmd_doc.py
@@ -55,7 +55,7 @@ def get_description_from_output(text: str) -> str:
 def render_title(text: str, cmd: str) -> str:
     return re.sub(
         r"^# CMD command$",
-        f"# {cmd.capitalize()} command",
+        f"# {cmd} command",
         text,
         flags=re.MULTILINE,
     )

diff --git a/docs/reference/cli-commands/exec.md b/docs/reference/cli-commands/exec.md
@@ -1,4 +1,4 @@
-# Exec command
+# exec command
 
 The exec command runs a remote command and waits for it to finish. The local
 

diff --git a/docs/reference/cli-commands/health.md b/docs/reference/cli-commands/health.md
@@ -1,4 +1,4 @@
-# Health command
+# health command
 
 The health command queries the health of configured checks.
 

diff --git a/docs/reference/cli-commands/help.md b/docs/reference/cli-commands/help.md
@@ -1,5 +1,5 @@
 (reference_pebble_help_command)=
-# Pebble help command
+# help command
 
 Use the **help** command (`help` or `-h`) to get a summary or detailed
 information about available `pebble` commands.

diff --git a/docs/reference/cli-commands/logs.md b/docs/reference/cli-commands/logs.md
@@ -1,4 +1,4 @@
-# Logs command
+# logs command
 
 The Pebble daemon's service manager stores the most recent stdout and stderr from each service, using a 100KB ring buffer per service. Each log line is prefixed with an RFC-3339 timestamp and the `[service-name]` in square brackets.
 

diff --git a/docs/reference/cli-commands/ls.md b/docs/reference/cli-commands/ls.md
@@ -1,4 +1,4 @@
-# Ls command
+# ls command
 
 The ls command lists entries in the filesystem at the specified path. A glob pattern
 

diff --git a/docs/reference/cli-commands/mkdir.md b/docs/reference/cli-commands/mkdir.md
@@ -1,4 +1,4 @@
-# Mkdir command
+# mkdir command
 
 The mkdir command creates the specified directory.
 

diff --git a/docs/reference/cli-commands/notice.md b/docs/reference/cli-commands/notice.md
@@ -1,4 +1,4 @@
-# Notice command
+# notice command
 
 The notice command fetches a single notice, either by ID (1-arg variant), or
 

diff --git a/docs/reference/cli-commands/notices.md b/docs/reference/cli-commands/notices.md
@@ -1,4 +1,4 @@
-# Notices command
+# notices command
 
 The notices command lists notices not yet acknowledged, ordered by the
 

diff --git a/docs/reference/cli-commands/notify.md b/docs/reference/cli-commands/notify.md
@@ -1,4 +1,4 @@
-# Notify command
+# notify command
 
 The notify command records a custom notice with the specified key and optional
 

diff --git a/docs/reference/cli-commands/okay.md b/docs/reference/cli-commands/okay.md
@@ -1,4 +1,4 @@
-# Okay command
+# okay command
 
 The okay command acknowledges warnings and notices that have been previously
 

diff --git a/docs/reference/cli-commands/plan.md b/docs/reference/cli-commands/plan.md
@@ -1,4 +1,4 @@
-# Plan command
+# plan command
 
 The plan command prints out the effective configuration of Pebble in YAML
 

diff --git a/docs/reference/cli-commands/pull.md b/docs/reference/cli-commands/pull.md
@@ -1,4 +1,4 @@
-# Pull command
+# pull command
 
 The pull command retrieves a file from the remote system.
 

diff --git a/docs/reference/cli-commands/push.md b/docs/reference/cli-commands/push.md
@@ -1,4 +1,4 @@
-# Push command
+# push command
 
 The push command transfers a file to the remote system.
 

diff --git a/docs/reference/cli-commands/replan.md b/docs/reference/cli-commands/replan.md
@@ -1,4 +1,4 @@
-# Pebble replan command
+# replan command
 
 The replan command starts, stops, or restarts services that have changed, so that running services exactly match the desired configuration in the current plan.
 

diff --git a/docs/reference/cli-commands/restart.md b/docs/reference/cli-commands/restart.md
@@ -1,4 +1,4 @@
-# Restart command
+# restart command
 
 The restart command restarts the named service(s) in the correct order.
 

diff --git a/docs/reference/cli-commands/rm.md b/docs/reference/cli-commands/rm.md
@@ -1,4 +1,4 @@
-# Rm command
+# rm command
 
 The rm command removes a file or directory.
 

diff --git a/docs/reference/cli-commands/run.md b/docs/reference/cli-commands/run.md
@@ -1,4 +1,4 @@
-# Pebble run command
+# run command
 
 The `run` command starts Pebble daemon and runs the configured environment.
 

diff --git a/docs/reference/cli-commands/services.md b/docs/reference/cli-commands/services.md
@@ -1,4 +1,4 @@
-# Pebble services command
+# services command
 
 The services command lists status information about the services specified, or about all services if none are specified.
 

diff --git a/docs/reference/cli-commands/signal.md b/docs/reference/cli-commands/signal.md
@@ -1,4 +1,4 @@
-# Signal command
+# signal command
 
 The signal command sends a signal to one or more running services. The signal
 

diff --git a/docs/reference/cli-commands/start.md b/docs/reference/cli-commands/start.md
@@ -1,4 +1,4 @@
-# Pebble start command
+# start command
 
 The start command starts the service with the provided name and any other services it depends on, in the correct order.
 

diff --git a/docs/reference/cli-commands/stop.md b/docs/reference/cli-commands/stop.md
@@ -1,4 +1,4 @@
-# Pebble stop command
+# stop command
 
 The stop command stops the service with the provided name and any other service that depends on it, in the correct order.
 

diff --git a/docs/reference/cli-commands/tasks.md b/docs/reference/cli-commands/tasks.md
@@ -1,4 +1,4 @@
-# Tasks command
+# tasks command
 
 The tasks command displays a summary of tasks associated with an individual
 

diff --git a/docs/reference/cli-commands/version.md b/docs/reference/cli-commands/version.md
@@ -1,4 +1,4 @@
-# Version command
+# version command
 
 The version command displays the versions of the running client and server.