docs: Improve XBlock tutorial sections 1-3 #692
Merged
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
sarina
force-pushed
the
sarina/improve-tutorial
branch
from
33dbf92 to
fc120e4
Compare
sarina
changed the title
|
@feanil this PR has a stalled build |
sarina
commented
Nov 19, 2023
|
|
||
| You use the XBlock SDK to create skeleton files for an XBlock. To do this, | ||
| follow these steps at a command prompt. | ||
|
|
||
| #. Change to the ``xblock_development`` directory, which contains the ``venv`` and ``xblock-sdk`` subdirectories. | ||
| #. Change to the ``xblock_development`` directory, which contains the | ||
| ``var``, ``xblock-env``, and ``xblock-sdk`` subdirectories. |
There was a problem hiding this comment.
I added var because we're told to do that in the clone-sdk file
sarina
commented
Nov 19, 2023
|
|
||
| #. You are prompted to indicate whether or not to create a Django superuser. |
There was a problem hiding this comment.
I deleted this because I was not prompted to create a Django superuser.
sarina
force-pushed
the
sarina/improve-tutorial
branch
from
812cba3 to
0cda2e1
Compare
feanil
approved these changes
Nov 27, 2023
|
@sarina I added a commit that should fix up the doc errors, so I think this should be good to go once you rebase and fix the glossary conflict. |
These aliases got renamed in the source file so update them where they are referenced.
feanil
force-pushed
the
sarina/improve-tutorial
branch
from
d9ed1bf to
64fff3c
Compare
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.
Simplify XBlock Tutorial introduction section (removed "front matter" section and consolidated on one page; moved "Browsers" under "Overview")
Update XBlock Tutorial overview section - particularly, renaming
venvtoxblock-envto make it clear that you're making a specific venv for this xblock, and also, that venvs can have unique names. I'm open to feedback on the exact name of the env. I'm also open to keeping itvenvbut explaining more that it's the name we're choosing for the environment (as written I think it can be a bit confusing that we're using venv as a name but also it's the name of the tool)Correct and update the Getting Started section. Updated the screenshot of the SDK workbench, depends on Use Open edX logo on workbench xblock-sdk#332