Skip to content

Commit

Permalink
fixup! af0aa65
Browse files Browse the repository at this point in the history
  • Loading branch information
sarina committed Nov 19, 2023
1 parent 59a1940 commit 33dbf92
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 22 deletions.
4 changes: 2 additions & 2 deletions docs/xblock-tutorial/getting_started/create_first_xblock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ it in the XBlock SDK.

.. include:: ../reusable/run_server.rst

******************
**********
Next Steps
******************
**********

You have now completed the Getting Started section of the XBlock tutorial. In
the next sections, you will learn :ref:`how to use the XBlock SDK <Using the
Expand Down
10 changes: 1 addition & 9 deletions docs/xblock-tutorial/reusable/create_db.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,5 @@ database.

.. code-block:: none
(venv) $ python xblock-sdk/manage.py migrate
(xblock-env) $ python xblock-sdk/manage.py migrate
#. You are prompted to indicate whether or not to create a Django superuser.

.. code-block:: none
You just installed Django's auth system, which means you don't have any
superusers defined. Would you like to create one now? (yes/no):
#. Enter ``no``.
9 changes: 5 additions & 4 deletions docs/xblock-tutorial/reusable/create_xblock.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
******************
****************
Create an XBlock
******************
****************

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.

#. Run the following command to create the skeleton
files for the XBlock.

.. code-block:: none
(venv) $ xblock-sdk/bin/workbench-make-xblock
(xblock-env) $ xblock-sdk/bin/workbench-make-xblock
Instructions in the command window instruct you to determine a short name
and a class name. Follow the guidelines in the command window to determine
Expand Down
2 changes: 1 addition & 1 deletion docs/xblock-tutorial/reusable/install_xblock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ In the ``xblock_development`` directory, use ``pip`` to install your XBlock.

.. code-block:: none
(venv) $ pip install -e myxblock
(xblock-env) $ pip install -e myxblock
You can then test your XBlock in the XBlock SDK.
12 changes: 6 additions & 6 deletions docs/xblock-tutorial/reusable/run_server.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**************************
*************************
Run the XBlock SDK Server
**************************
*************************

To see the web interface of the XBlock SDK, you must run the SDK server.

Expand All @@ -9,7 +9,7 @@ server.

.. code-block:: none
(venv) $ python xblock-sdk/manage.py runserver
(xblock-env) $ python xblock-sdk/manage.py runserver
.. note:: If you do not specify a port, the XBlock SDK server uses port 8000.
To use a different port, specify it in the ``runserver`` command.
Expand All @@ -25,15 +25,15 @@ The page shows the XBlocks installed automatically with the XBlock SDK. Note
that the page also shows the **MyXBlock** XBlock that you created in
:ref:`Create Your First XBlock`.

====================================
==================================
Get Help for the XBlock SDK Server
====================================
==================================

To get help for the XBlock SDK ``runserver`` command, run the following
command.

.. code-block:: none
(venv) $ python xblock-sdk/manage.py help
(xblock-env) $ python xblock-sdk/manage.py help
The command window lists and describes the available commands.

0 comments on commit 33dbf92

Please sign in to comment.