Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit bfe6e7a

Browse files
authored
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.
1 parent d965113 commit bfe6e7a

1 file changed

Lines changed: 6 additions & 13 deletions

File tree

docs/pycharm_integration.rst

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ following:
2626
start button with no further error when this problem occurs. See `Jetbrains
2727
ticket PY-22893`_.
2828

29-
2. If you are running with Docker Sync on a mac you will want to first run
30-
``docker-sync start`` to run sync in the background before running any
31-
servers or tests.
29+
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`_.
30+
31+
.. _deprecation of docker-sync: https://openedx.atlassian.net/browse/DEPR-162
3232

3333
Setup a Remote Interpreter
3434
--------------------------
@@ -43,16 +43,9 @@ use the following options:
4343

4444
- Configuration files(s)
4545

46-
- Docker Sync (Mac)
47-
48-
- ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml)
49-
- ``/LOCAL/PATH/TO/devstack/docker-compose-sync.yml``
50-
51-
- Without Docker Sync
52-
53-
- ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml)
54-
- ``/LOCAL/PATH/TO/devstack/docker-compose-host.yml``
55-
- ``/LOCAL/PATH/TO/devstack/docker-compose-themes.yml``
46+
- ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml)
47+
- ``/LOCAL/PATH/TO/devstack/docker-compose-host.yml``
48+
- ``/LOCAL/PATH/TO/devstack/docker-compose-themes.yml``
5649

5750
- Service: lms (or whatever IDA you wish to test)
5851

0 commit comments

Comments
 (0)