diff --git a/docs/links.rst b/docs/links.rst index f8faa002a..3716041e9 100644 --- a/docs/links.rst +++ b/docs/links.rst @@ -31,6 +31,8 @@ .. _VirtualEnvWrapper: http://virtualenvwrapper.readthedocs.io/en/latest +.. _managing different Python versions with virtualenv: https://saturncloud.io/blog/how-to-use-different-python-versions-with-virtualenv/ + .. _XBlock SDK: https://github.com/openedx/xblock-sdk .. _PyEnv: https://github.com/yyuu/pyenv diff --git a/docs/xblock-tutorial/Images/sdk_ui.png b/docs/xblock-tutorial/Images/sdk_ui.png index 0e232965e..7c2c3c60c 100644 Binary files a/docs/xblock-tutorial/Images/sdk_ui.png and b/docs/xblock-tutorial/Images/sdk_ui.png differ diff --git a/docs/xblock-tutorial/getting_started/create_first_xblock.rst b/docs/xblock-tutorial/getting_started/create_first_xblock.rst index e06d090d2..90a45ba44 100644 --- a/docs/xblock-tutorial/getting_started/create_first_xblock.rst +++ b/docs/xblock-tutorial/getting_started/create_first_xblock.rst @@ -1,8 +1,8 @@ .. _Create Your First XBlock: -######################### +######################## Create Your First XBlock -######################### +######################## Before you continue, make sure that you have :ref:`set up the XBlock SDK `. You then create the XBlock and deploy @@ -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 `. +When the requirements are installed, you are in the ``xblock_development`` +directory, which contains the ``var``, ``xblock-env``, and ``xblock-sdk`` +subdirectories. You can now :ref:`create your first XBlock `. .. include:: ../../links.rst diff --git a/docs/xblock-tutorial/reusable/clone_sdk.rst b/docs/xblock-tutorial/reusable/clone_sdk.rst index 1bc9657e8..27413a33d 100644 --- a/docs/xblock-tutorial/reusable/clone_sdk.rst +++ b/docs/xblock-tutorial/reusable/clone_sdk.rst @@ -14,29 +14,29 @@ requirements. To do this, complete the following steps at a command prompt. .. code-block:: bash - (venv) $ git clone https://github.com/openedx/xblock-sdk.git + (xblock-env) $ git clone https://github.com/openedx/xblock-sdk.git #. In the same directory, create an empty directory called `var`. .. code-block:: bash - (venv) $ mkdir var + (xblock-env) $ mkdir var #. Run the following command to change to the ``xblock-sdk`` directory. .. code-block:: bash - (venv) $ cd xblock-sdk + (xblock-env) $ cd xblock-sdk #. Run the following commands to install the XBlock SDK requirements. .. code-block:: bash - (venv) $ make install + (xblock-env) $ make install #. Run the following command to return to the ``xblock_development`` directory, where you will perform the rest of your work. .. code-block:: bash - (venv) $ cd .. + (xblock-env) $ cd .. diff --git a/docs/xblock-tutorial/reusable/create_db.rst b/docs/xblock-tutorial/reusable/create_db.rst index c328b3b83..3f6533798 100644 --- a/docs/xblock-tutorial/reusable/create_db.rst +++ b/docs/xblock-tutorial/reusable/create_db.rst @@ -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``. diff --git a/docs/xblock-tutorial/reusable/create_xblock.rst b/docs/xblock-tutorial/reusable/create_xblock.rst index eb9feac0d..45adaf525 100644 --- a/docs/xblock-tutorial/reusable/create_xblock.rst +++ b/docs/xblock-tutorial/reusable/create_xblock.rst @@ -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 diff --git a/docs/xblock-tutorial/reusable/install_xblock.rst b/docs/xblock-tutorial/reusable/install_xblock.rst index 81e2bfab5..3c0250809 100644 --- a/docs/xblock-tutorial/reusable/install_xblock.rst +++ b/docs/xblock-tutorial/reusable/install_xblock.rst @@ -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. diff --git a/docs/xblock-tutorial/reusable/run_server.rst b/docs/xblock-tutorial/reusable/run_server.rst index bdaf4afff..596bc8767 100644 --- a/docs/xblock-tutorial/reusable/run_server.rst +++ b/docs/xblock-tutorial/reusable/run_server.rst @@ -1,6 +1,6 @@ -************************** +************************* Run the XBlock SDK Server -************************** +************************* To see the web interface of the XBlock SDK, you must run the SDK server. @@ -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. @@ -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.