From 58486795c8a8b4ac7269340d19a7db183661dbb1 Mon Sep 17 00:00:00 2001 From: Danyal-Faheem Date: Wed, 13 Nov 2024 14:23:41 +0500 Subject: [PATCH] docs: update readme for attaching containers --- docs/tutorials/edx-platform.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/tutorials/edx-platform.rst b/docs/tutorials/edx-platform.rst index 125a0cb324..7ae47f22ad 100644 --- a/docs/tutorials/edx-platform.rst +++ b/docs/tutorials/edx-platform.rst @@ -128,16 +128,18 @@ After you implement and enable that plugin, ``tutor mounts list`` should display Debugging with breakpoints -------------------------- -To debug a local edx-platform repository, first, start development in detached mode (with ``-d``), add a `python breakpoint `__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name:: +To debug a local edx-platform repository, first, start development in detached mode (with ``-d``), add a `python breakpoint `__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``attach`` followed by the service's name:: # Start in detached mode: tutor dev start -d # Debugging LMS: - tutor dev start lms + tutor dev attach lms # Or, debugging CMS: - tutor dev start cms + tutor dev attach cms + +To detach from the container without shutting it down, use ``Ctrl+p`` followed with ``Ctrl+q``. Running edx-platform unit tests ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~