doc: intellij/pycharm run configurations for OpenEdx with tutor #1027
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@regisb could you help reviewing this PR? |
DawoudSheraz
reviewed
Apr 9, 2024
| @@ -0,0 +1,105 @@ | |||
| Debug Open edX with IntelliJ IDEA and Add a Python Remote SDK | |||
There was a problem hiding this comment.
For clarity, this is specific to edx-platform, right? I think we should mention that explicitly in the heading.
DawoudSheraz
reviewed
Apr 9, 2024
| Debug Open edX with IntelliJ IDEA and Add a Python Remote SDK | ||
| ============================================================== | ||
|
|
||
| To debug Open edX with IntelliJ IDEA and add a Python remote SDK, follow these steps: |
There was a problem hiding this comment.
We can specify in what cases we would need a Python Remote SDK. I expect it is needed for IntelliJ as a general but not for PyCharm?
DawoudSheraz
reviewed
Apr 9, 2024
| Install Required Tools | ||
| ---------------------- | ||
|
|
||
| Make sure you have Docker and (IntelliJ IDEA or PyCharm) is installed on your system along with the Python and Docker plugin. |
There was a problem hiding this comment.
nit: Docker and IntelliJ IDEA or PyCharm are installed
DawoudSheraz
reviewed
Apr 9, 2024
| Install Required Tools | ||
| ---------------------- | ||
|
|
||
| Make sure you have Docker and (IntelliJ IDEA or PyCharm) is installed on your system along with the Python and Docker plugin. |
There was a problem hiding this comment.
Which Python and Docker plugins to be specific?
DawoudSheraz
reviewed
Apr 9, 2024
|
|
||
| Make sure you have Docker and (IntelliJ IDEA or PyCharm) is installed on your system along with the Python and Docker plugin. | ||
|
|
||
| Setup OpenEdx with tutor |
There was a problem hiding this comment.
nit: OpenEdx --> Open edX
DawoudSheraz
reviewed
Apr 9, 2024
| Setup OpenEdx with tutor | ||
| ------------------------ | ||
|
|
||
| Below are the few steps you need to follow inorder add remote sdk. |
There was a problem hiding this comment.
nit: in order to add a remote sdk
|
Closing this PR as this should not be in Tutor's official docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Debug Open edX with IntelliJ IDEA and Add a Python Remote SDK — Tutor documentation.pdf