Skip to content

Commit

Permalink
docs: remove docker-sync docs (openedx-unsupported#826)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
robrap authored Aug 25, 2021
1 parent d965113 commit bfe6e7a
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions docs/pycharm_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------
Expand All @@ -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)

Expand Down

0 comments on commit bfe6e7a

Please sign in to comment.