Skip to content

Commit

Permalink
doc: Update the XBlock Tutorial Getting Started section
Browse files Browse the repository at this point in the history
  • Loading branch information
sarina committed Nov 19, 2023
1 parent 9d7cbe1 commit af0aa65
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 17 deletions.
18 changes: 9 additions & 9 deletions docs/xblock-tutorial/getting_started/prereqs.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _Install XBlock Prerequisites:

################################
############################
Install XBlock Prerequisites
################################
############################

To build an XBlock, you must have the following tools on your computer.

Expand All @@ -11,31 +11,31 @@ To build an XBlock, you must have the following tools on your computer.
:depth: 1


***********
**********
Python 3.8
***********
**********

To run the a virtual environment and the XBlock SDK, and to build an XBlock,
you must have Python 3.8 installed on your computer.

`Download Python`_ for your operating system and follow the installation
instructions.

****
***
Git
****
***

EdX repositories, including XBlock and the XBlock SDK, are stored on GitHub.
Open edX repositories, including XBlock and the XBlock SDK, are stored on GitHub.

To build your own XBlock, and to deploy it later, you must use Git for source
control.

If you do not have Git installed, or you are are unfamiliar with the tool, see
the `GitHub Help`_.

************************
*********************
A Virtual Environment
************************
*********************

It is recommended that you develop your XBlock using a Python virtual
environment. A virtual environment is a tool to keep the dependencies required
Expand Down
19 changes: 11 additions & 8 deletions docs/xblock-tutorial/getting_started/setup_sdk.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _Set Up the XBlock Software Development Kit:

###########################################
##########################################
Set Up the XBlock Software Development Kit
###########################################
##########################################

Before you continue, make sure that you are familiar with the subjects in the
:ref:`Install XBlock Prerequisites` section.
Expand All @@ -14,9 +14,9 @@ SDK`_ in a virtual environment. To do this, complete the following steps.
:local:
:depth: 1

********************************************
**********************************
Create a Directory for XBlock Work
********************************************
**********************************

It is recommended that you create a directory in which to store all your XBlock
work, including a virtual environment, the XBlock SDK, and the XBlocks you
Expand All @@ -38,11 +38,12 @@ develop.

.. _Create and Activate the Virtual Environment:

********************************************
*******************************************
Create and Activate the Virtual Environment
********************************************
*******************************************

You must have a virtual environment tool installed on your computer. For more information, see :ref:`Install XBlock Prerequisites`.
You must have a virtual environment tool installed on your computer. For more
information, see :ref:`Install XBlock Prerequisites`.

Then create the virtual environment in your ``xblock_development`` directory.

Expand All @@ -68,6 +69,8 @@ Then create the virtual environment in your ``xblock_development`` directory.
.. include:: ../reusable/clone_sdk.rst

When the requirements are installed, you are in the ``xblock_development`` directory, which contains the ``venv`` and ``xblock-sdk`` subdirectories. You can now :ref:`create your first XBlock <Create Your First XBlock>`.
When the requirements are installed, you are in the ``xblock_development``
directory, which contains the ``venv`` and ``xblock-sdk`` subdirectories. You
can now :ref:`create your first XBlock <Create Your First XBlock>`.

.. include:: ../../links.rst

0 comments on commit af0aa65

Please sign in to comment.