Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

minor doc changes

  • Loading branch information...
commit 6517a71b01076a17b07c90bbd017f0dc97dc6215 1 parent 6188893
@bretth authored
Showing with 10 additions and 9 deletions.
  1. +1 −1  INSTALL.txt
  2. +3 −2 docs/main.rst
  3. +6 −6 docs/tutorial.rst
View
2  INSTALL.txt
@@ -2,7 +2,7 @@ You are using pip right?
``pip install woven``
-You may also want to install the following recommended packages::
+You may also want to install the following recommended packages:
``pip install south``
View
5 docs/main.rst
@@ -38,7 +38,7 @@ Getting Started
To use Woven you must have root access to a linux host or vm. Woven has currently been tested on Ubuntu >= 10.04.
-Woven uses a custom ``woven-admin.py`` script that serves to replace django-admin.py and manage.py in your development environment, and allows you to use woven commands without adding woven to your installed apps.
+Woven uses a custom ``woven-admin.py`` script that serves to replace ``django-admin.py`` and ``manage.py`` in your development environment, and allows you to use woven commands without adding woven to your installed apps.
Run ``woven-admin.py startproject`` which will create a basic django project distribution layout.
@@ -78,7 +78,6 @@ Woven provides hooks into the setupnode, deploy, and post package installation c
To add custom functionality to a woven deployment create a ``deploy.py`` file in your project or django app, and define any of the following.
-Hooks execute in a project, app, woven order of precedence. Only one hook per function will execute. A project scope hook for instance will override the same function at app or provided by woven itself.
Post install package
---------------------
@@ -97,6 +96,8 @@ Post deploy
``def post_deploy()`` executes at the end of deployment of your project but prior to activation.
+Hooks execute in a project, app, woven order of precedence. Only one hook per function will execute. A project scope hook for instance will override the same function at app or provided by woven itself.
+
Multiple Sites
==============
View
12 docs/tutorial.rst
@@ -32,13 +32,13 @@ It should also install django, fabric, and paramiko if they aren't already insta
Creating the distribution and project
--------------------------------------
-Create a project distribution and files using woven's woven-admin.py script. A distribution is all the files including media and other data relating to the project wheras the project is just the Django project. We're going to call the distribution something different from the actual project.
+Create a project distribution and files using woven's ``woven-admin.py`` script. A distribution is all the files including media and other data relating to the project wheras the project is just the Django project. We're going to call the distribution something different from the actual project.
``woven-admin.py startproject helloadmin woven@example.com --dist=firstdjango``
-woven-admin.py extends django-admin.py allowing us to use woven commands without adding woven itself to the ``INSTALLED_APPS`` setting. We can use an optional email address to create a default superuser, though if you didn't define one woven would still offer to create one based on the project name. As you'll discover, woven's ethos combines convenience with flexibility. Sometimes you need to get somewhere in a hurry.
+``woven-admin.py`` extends ``django-admin.py`` allowing us to use woven commands without adding woven itself to the ``INSTALLED_APPS`` setting.
-You'll notice that it's a little different from ``django-admin.py startproject`` in that it creates a setup.py and a few other folders, and merges in the syncdb and creates a default superuser based on the user part of the optional email address (in this case 'woven') or the project name if you want one, though you can skip this behaviour with --nosyncdb.
+You'll notice that it's a little different from ``django-admin.py startproject`` in that it creates a ``setup.py`` and a few other folders, and merges in the syncdb and creates a default superuser based on the user part of the optional email address (in this case 'woven') or the project name if you want one, though you can skip this behaviour with ``--nosyncdb``. As you'll discover, woven's ethos combines convenience with flexibility. Sometimes you need to get somewhere in a hurry, or just want a project you can throw away after using.
The setup.py is where woven gets your distribution name, project name and project version metadata which is used in deployments, it's just not used to package your project... yet.
@@ -46,9 +46,9 @@ The setup.py is where woven gets your distribution name, project name and projec
Versions are critical to woven, and how woven differs from most deployment tools. Woven deploys a separate virtualenv just like the one we created earlier for *each* version of your distribution. This means you don't destroy an existing working environment when you deploy a new version. You could use this feature to test different features, or simply to rollback from a failed release. Not that you'll ever have a failed release. Ever.
-Woven's alternative to django's ``startproject`` creates some sensible folders for media, static (app) content, templates, and database, and uses an alternative settings file from the django default to get you up and running fast. Nothing stopping you from changing it later if you want or you can also use ``startproject -t`` option to specify alternative starting templates for your project.
+Woven's alternative to django's ``startproject`` also creates some sensible folders for media, static (app) content, templates, and database, and uses an alternative settings file from the django default. Nothing stopping you from changing it later if you want or you can also use ``startproject -t`` option to specify alternative starting templates for your project.
-In your urls.py we'll add a simple index page.
+In your urls.py we'll add a simple index page.::
urlpatterns += patterns('django.views.generic.simple',
(r'^$', 'direct_to_template', {'template': 'index.html'}),
@@ -115,7 +115,7 @@ Deploy sets up a virtual environment on the server and deploys your sqlite3 data
Everything in a deployment is versioned right down to the web configuration files. The only thing that isn't versioned is your database and MEDIA_ROOT. If you get errors, from misconfiguration or package installs, you can just fix your issue and run it again until it completes and activates your environment.
-You'll also notice woven has created a pip ``requirements.txt`` file and a ``sitesettings`` folder with some settings files inside. These will import and override your local settings file on the node.
+You'll also notice woven has created a pip ``requirements.txt`` file and a ``sitesettings`` folder with a setting file inside. Requirements are your pip requirements for the project. The sitesettings.settings.py will import and override your local settings file on the node.
Patch
------
Please sign in to comment.
Something went wrong with that request. Please try again.