|
|
3.
|
|
|
This is a list in progress as I work on the user manual. There are a number of things for which I created conventions. I want to keep them in a central space so that others have access to them and that I can refer to them as well. ;-)
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
4.
|
|
|
The list is not in any particular order.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
5.
|
|
|
Install Sphinx
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:13
|
|
|
6.
|
|
|
The Mahara user manual requires that Sphinx is installed on your computer. You can find information on how to install Sphinx on the `Sphinx website <http://sphinx-doc.org/>`_.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:17
|
|
|
7.
|
|
|
Getting the code
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:20
|
|
|
8.
|
|
|
The code for the Mahara user manual is managed in git.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:22
|
|
|
9.
|
|
|
Create a folder on your computer (if you don't already) where you place git repositories, e.g. ``code``.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:24
|
|
|
10.
|
|
|
In the terminal, enter the folder "code": ``cd code``
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:24
|
|
|
11.
|
|
|
Do a checkout of the code:
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:26
|
|
|
12.
|
|
|
via SSH: ``git clone git@git.mahara.org:user-manual/manual.git`` **OR**
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:25
|
