Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: use correct keypress style, fix markup #722

Merged
merged 2 commits into from
Oct 3, 2024
Merged

docs: use correct keypress style, fix markup #722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15c0027
docs: add correct keypress markup
medubelko Oct 1, 2024
a61e85b
[review] re-add "ctrl" to linter allowlist
medubelko Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cli
CMake
cmake
CMD
CTRL
Ctrl
dataset
Deadsnakes
declaratively
Expand Down
6 changes: 4 additions & 2 deletions docs/tutorial/django.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======================================
Expand Down Expand Up @@ -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
~~~~~~~
Expand Down
6 changes: 4 additions & 2 deletions docs/tutorial/flask.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
======================================
Expand Down Expand Up @@ -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::

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/node-app.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading