From 1d87e33cf207b3a2f16eb125743ec11546fa0cb1 Mon Sep 17 00:00:00 2001 From: Michael DuBelko Date: Thu, 3 Oct 2024 04:21:47 -0700 Subject: [PATCH] docs: use correct keypress style, fix markup (#722) * docs: add correct keypress markup In compliance with the Ubuntu and reST style guides. * [review] re-add "ctrl" to linter allowlist Turns out the linter doesn't respect :kbd: fences. --- docs/.wordlist.txt | 2 +- docs/tutorial/django.rst | 6 ++++-- docs/tutorial/flask.rst | 6 ++++-- docs/tutorial/node-app.rst | 4 ++-- 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/.wordlist.txt b/docs/.wordlist.txt index 21615ba82..2daf52a96 100644 --- a/docs/.wordlist.txt +++ b/docs/.wordlist.txt @@ -10,7 +10,7 @@ cli CMake cmake CMD -CTRL +Ctrl dataset Deadsnakes declaratively diff --git a/docs/tutorial/django.rst b/docs/tutorial/django.rst index 1c61433d6..ee93febe3 100644 --- a/docs/tutorial/django.rst +++ b/docs/tutorial/django.rst @@ -68,7 +68,8 @@ The Django application should respond with it difficult to read on a terminal. Visit ``http://localhost:8000`` using a browser to see the fully rendered page. -The Django application looks good, so you can stop it for now using ``ctrl+C``. +The Django application looks good, so let's stop it for now by pressing +:kbd:`Ctrl` + :kbd:`C`. Pack the Django application into a rock ======================================= @@ -211,7 +212,8 @@ You should expect to see something similar to this: 2024-08-20T06:34:36.116Z [django] [2024-08-20 06:34:36 +0000] [18] [INFO] Booting worker with pid: 18 You can also choose to follow the logs by using the ``-f`` option with the -``pebble logs`` command above. To stop following the logs, press ``ctrl+c``. +``pebble logs`` command above. To stop following the logs, press :kbd:`Ctrl` + +:kbd:`C`. Cleanup ~~~~~~~ diff --git a/docs/tutorial/flask.rst b/docs/tutorial/flask.rst index 257147ee2..3c48d08c3 100644 --- a/docs/tutorial/flask.rst +++ b/docs/tutorial/flask.rst @@ -66,7 +66,8 @@ endpoint. You may need a new terminal for this, if you are using Multipass use The Flask application should respond with ``Hello, world!``. -The Flask application looks good, so stop it for now using ``ctrl+C``. +The Flask application looks good, so let's stop it for now by pressing +:kbd:`Ctrl` + :kbd:`C`. Pack the Flask application into a rock ====================================== @@ -205,7 +206,8 @@ You should expect to see something similar to this: 2024-06-21T03:41:45.078Z [flask] [2024-06-21 03:41:45 +0000] [18] [INFO] Booting worker with pid: 18 You can also choose to follow the logs by using the ``-f`` option with the -``pebble logs`` command above. To stop following the logs, press ``ctrl+c``. +``pebble logs`` command above. To stop following the logs, press :kbd:`Ctrl` + +:kbd:`C`. .. note:: diff --git a/docs/tutorial/node-app.rst b/docs/tutorial/node-app.rst index 1543cf53e..854787348 100644 --- a/docs/tutorial/node-app.rst +++ b/docs/tutorial/node-app.rst @@ -135,8 +135,8 @@ open another shell into the VM and access the app with curl: This should also print "Hello World from inside the rock!" to the terminal. -You can now stop the running container by either interrupting it with CTRL+C or -by running the following in another terminal: +You can now stop the running container by either interrupting it with +:kbd:`Ctrl` + :kbd:`C` or by running the following in another terminal: .. literalinclude:: code/node-app/task.yaml :language: bash