Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

improved installation and tutorial documentation

  • Loading branch information...
commit 9b47e0dbb891782ad5a90a7335a2c9b0821385de 1 parent 9d0323a
@ojii ojii authored
View
36 docs/getting_started/installation.rst
@@ -2,8 +2,8 @@
Installation
############
-This document assumes you are familiar with Python and Django, and should outline
-the steps necessary for you to follow the :doc:`tutorial`.
+This document assumes you are familiar with Python and Django, and should
+outline the steps necessary for you to follow the :doc:`tutorial`.
************
Requirements
@@ -14,7 +14,11 @@ Requirements
* `South`_ 0.7.2 or higher
* `PIL`_ 1.1.6 or higher
* `django-classy-tags`_ 0.2.2 or higher
-* An installed and working instance of one of the databases listed in the Databases section.
+* An installed and working instance of one of the databases listed in the
+ `Databases`_ section.
+
+.. note:: When installing the django CMS using pip, both Django and
+ django-classy-tags will be installed automatically.
.. _Python: http://www.python.org
.. _Django: http://www.djangoproject.com
@@ -25,7 +29,8 @@ Requirements
On Ubuntu
=========
-If you're using Ubuntu (tested with 10.10), the following should get you started:
+If you're using Ubuntu (tested with 10.10), the following should get you
+started:
``sudo aptitude install python2.6 python-setuptools python-imaging``
@@ -35,19 +40,19 @@ If you're using Ubuntu (tested with 10.10), the following should get you started
Additionally, you need the python driver for your selected database:
-``sudo aptitude install python-mysql``
-or
``sudo aptitude python-psycopg2``
+or
+``sudo aptitude install python-mysql``
This will install PIL and your database's driver globally.
-You have now everything that is needed for you to follow the :doc:`tutorial`
+You have now everything that is needed for you to follow the :doc:`tutorial`.
On Mac OSX
==========
-**TODO** (Should setup everything up to but not including "pip install django-cms" like
-the above)
+**TODO** (Should setup everything up to but not including
+"pip install django-cms" like the above)
On Microsoft Windows
====================
@@ -58,15 +63,14 @@ On Microsoft Windows
Databases
*********
-We recommend using `PostgreSQL`_ or `MySQL`_ with Django CMS. Installing and maintaining
-database systems is outside the scope of this documentation, but is very well documented
-on the system's respective websites.
+We recommend using `PostgreSQL`_ or `MySQL`_ with Django CMS. Installing and
+maintaining database systems is outside the scope of this documentation, but is
+very well documented on the system's respective websites.
To use Django CMS efficiently, we recommend:
-* Create a separate set of credentials for Django CMS
-* Create a separate database for Django CMS to use.
+* Create a separate set of credentials for django CMS.
+* Create a separate database for django CMS to use.
.. _PostgreSQL: http://www.postgresql.org/
-.. _MySQL: http://www.mysql.com
-
+.. _MySQL: http://www.mysql.com
View
58 docs/getting_started/tutorial.rst
@@ -2,40 +2,12 @@
Introductory Tutorial
#####################
-************
-Installation
-************
-
This guide assumes your machine meets the requirements outlined in the
-:doc:`installation` section of this documentation. Please refer to this section for
-more information.
-
-Installing Django CMS
-=====================
-
-While we strongly encourage you to install the django CMS using `buildout`_ or
-`virtualenv`_, for the sake of simplicity this guide will install Django CMS
-system wide. For more details about how either of theses projects work please
-refer to their respective documentation.
-
-Install the latest django CMS package::
-
- $ sudo pip install django-cms south django-appmedia
-
-Or install the latest revision from github::
-
- $ sudo pip install -e git+git://github.com/divio/django-cms.git#egg=django-cms
- $ sudo pip install south django-appmedia
-
-To check if you installed django CMS properly, open a Python shell and type::
-
- import cms
-
-If this does not return an error, you've successfully installed django CMS.
-
-.. _buildout: http://www.buildout.org/
-.. _virtualenv: http://virtualenv.openplans.org/
+:doc:`installation` section of this documentation.
+***********************
+Configuration and setup
+***********************
Preparing the environment
=========================
@@ -158,8 +130,26 @@ now, and simply paste this code in your settings file.
The templates you define in ``CMS_TEMPLATES`` have to exist at runtime and
contain at least one ``{% placeholder <name> %}`` template tag to be useful
for django CMS. For more details see `Creating templates`_
-
-Finally, setup the ``DATABASES`` part of the file to reflect your database deployement.
+
+The django CMS will allow you to edit all languages which Django has built in
+translations for, this is way too many so we'll limit it to English for now::
+
+ LANGUAGES = [
+ ('en', 'English'),
+ ]
+
+Finally, setup the ``DATABASES`` part of the file to reflect your database
+deployement. If you just want to try out things locally, sqlite3 is the easiest
+database to set up, however it should not be used in production. If you still
+wish to use it for now, this is what your ``DATABASES`` setting should look
+like::
+
+ DATABASES = {
+ 'default': {
+ 'ENGINE': 'django.db.backends.sqlite3',
+ 'NAME': os.path.join(PROJECT_DIR, 'database.sqlite'),
+ }
+ }
URL configuration
Please sign in to comment.
Something went wrong with that request. Please try again.