From bfe6e7a3cf6f2b891d51809af3fd526302eb980d Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Wed, 25 Aug 2021 12:31:34 -0400 Subject: [PATCH] docs: remove docker-sync docs (#826) Docker sync has been deprecated in DEPR-162, and these instructions that were misleading for Mac users. The instructions were updated to simply state that users should not be using docker-sync. --- docs/pycharm_integration.rst | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/docs/pycharm_integration.rst b/docs/pycharm_integration.rst index 38e928a11b..f187c72b55 100644 --- a/docs/pycharm_integration.rst +++ b/docs/pycharm_integration.rst @@ -26,9 +26,9 @@ following: start button with no further error when this problem occurs. See `Jetbrains ticket PY-22893`_. -2. If you are running with Docker Sync on a mac you will want to first run - ``docker-sync start`` to run sync in the background before running any - servers or tests. +2. Ensure you are not using docker-sync (i.e. not using any make commands with ``sync`` in their name). Read more about the `deprecation of docker-sync`_. + +.. _deprecation of docker-sync: https://openedx.atlassian.net/browse/DEPR-162 Setup a Remote Interpreter -------------------------- @@ -43,16 +43,9 @@ use the following options: - Configuration files(s) - - Docker Sync (Mac) - - - ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml) - - ``/LOCAL/PATH/TO/devstack/docker-compose-sync.yml`` - - - Without Docker Sync - - - ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml) - - ``/LOCAL/PATH/TO/devstack/docker-compose-host.yml`` - - ``/LOCAL/PATH/TO/devstack/docker-compose-themes.yml`` + - ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml) + - ``/LOCAL/PATH/TO/devstack/docker-compose-host.yml`` + - ``/LOCAL/PATH/TO/devstack/docker-compose-themes.yml`` - Service: lms (or whatever IDA you wish to test)