changeset 40:f4308cd49ba2

improved docs
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Mon, 28 Feb 2011 15:19:17 +0100
parents 23c10f59e082
children 5ac57ba008b5
files docs/admin/install.rst docs/admin/requirements.rst docs/admin/serve.rst docs/intro/features.rst docs/intro/license.rst
diffstat 5 files changed, 19 insertions(+), 25 deletions(-) [+]
line wrap: on
line diff
--- a/docs/admin/install.rst	Mon Feb 28 05:03:21 2011 +0100
+++ b/docs/admin/install.rst	Mon Feb 28 15:19:17 2011 +0100
@@ -9,7 +9,7 @@
 
 Alternative 1 (using Mercurial DVCS)::
 
- $ hg clone http://hg.moinmo.in/moin/2.0 moin2
+ $ hg clone http://hg.moinmo.in/moin/2.0 moin-2.0
 
 Alternative 2:
 Visit http://hg.moinmo.in/moin/2.0 with your web browser, download the tgz
@@ -28,7 +28,7 @@
 
  ./quickinstall  # for linux (or other posix OSes)
  # or
- quickinstall.cmd  # for windows
+ quickinstall.bat  # for windows
 
 This will use virtualenv to create a directory `env/` and create a virtual
 environment for moin there and then install moin2 including all dependencies
--- a/docs/admin/requirements.rst	Mon Feb 28 05:03:21 2011 +0100
+++ b/docs/admin/requirements.rst	Mon Feb 28 15:19:17 2011 +0100
@@ -2,11 +2,9 @@
 Requirements
 ============
 
-MoinMoin requires Python >= 2.6, we recommend using 2.6.x.
+MoinMoin requires Python >= 2.6 and < 3.0.
 
-Python 3.x won't work for MoinMoin for now.
-
-Python build options:
+Python build options (in case you have to build your own Python):
 
 * zlib support (required)
 * ucs4 (32bit unicode, recommended)
@@ -21,11 +19,10 @@
 * the builtin "moin" server (recommended for desktop wikis, testing,
   debugging, development, adhoc-wikis)
 * apache with mod_wsgi (recommended for bigger/busier wikis)
-* other WSGI-compatible servers
 * For cgi, fastcgi, scgi, ajp, ... you can use the "flup" middleware:
   http://trac.saddi.com/flup
-* For IIS 6.0 on Windows 2003, you can use a ISAPI-WSGI gateway:
-  http://code.google.com/p/isapi-wsgi/ v0.4.1 has been used successfully.
+* IIS with ISAPI-WSGI gateway: http://code.google.com/p/isapi-wsgi/
+* other WSGI-compatible servers or middlewares
 
 
 Dependencies (Python code)
@@ -33,7 +30,8 @@
 
 For dependency information of python libs, please see setup.py.
 
-If you use easy_install or pip, this is usually automatically dealt with.
+If you use easy_install or pip (or our ``quickinstall`` script),
+this is usually automatically dealt with.
 
 
 Dependencies (static files)
@@ -41,6 +39,9 @@
 
 This is stuff like javascript, java applets, etc.
 
+If you use our ``quickinstall`` script, this is usually automatically dealt
+with.
+
 If you are a Linux distributor you may want to package this software
 separately and adapt wikiconfig.py (or the defaults in
 MoinMoin/config/default.py).
--- a/docs/admin/serve.rst	Mon Feb 28 05:03:21 2011 +0100
+++ b/docs/admin/serve.rst	Mon Feb 28 15:19:17 2011 +0100
@@ -2,14 +2,9 @@
 Server options
 ==============
 
-There are basically 2 things needing configuration:
-
-* the web server (IP address, port, hostname, ...)
-* the MoinMoin wiki engine (how the wiki behaves)
-
 Builtin Web Server (easy)
 =========================
-Moin comes with some simple builtin web server (provided by werkzeug), which
+Moin comes with a simple builtin web server (provided by werkzeug), which
 is suitable for development, debugging, personal and small group wikis.
 
 It is not made for serving bigger loads, but it is easy to use.
--- a/docs/intro/features.rst	Mon Feb 28 05:03:21 2011 +0100
+++ b/docs/intro/features.rst	Mon Feb 28 15:19:17 2011 +0100
@@ -40,7 +40,7 @@
 =============
 * Access Control Lists (ACLs)
 
-  - global (per backend)
+  - global (per storage backend)
   - local (per wiki item)
   - give rights like:
 
@@ -67,7 +67,7 @@
 * we store data of any type (text, images, audio, binary)
 * we separately store any metadata
 * everything is revisioned
-* all important metadata items are indexed
+* all important metadata is indexed
 
 Storage Backend Types
 ---------------------
@@ -104,7 +104,7 @@
 * Tags / Tag Cloud
 * Missing Items
 * Orphaned Items
-* What refers here?
+* "What refers here?" functionality
 * Sitemap
 * Macro support
 
--- a/docs/intro/license.rst	Mon Feb 28 05:03:21 2011 +0100
+++ b/docs/intro/license.rst	Mon Feb 28 15:19:17 2011 +0100
@@ -2,14 +2,12 @@
 
 .. _license:
 
-License
-=======
-MoinMoin is licensed under the GNU GPL v2 (or any later version).
+.. literalinclude:: ../../LICENSE.txt
 
-For a FAQ about the GPL, a copy of the misc. GPL license versions, please see
-there: http://www.gnu.org/licenses/gpl.html
+For a FAQ about the GPL and a copy of the misc. GPL license versions,
+please see there: http://www.gnu.org/licenses/gpl.html
 
-Here is the GNU GPL v2 text:
+This is the GNU GPL version 2 (from file docs/licenses/COPYING):
 
 .. literalinclude:: ../licenses/COPYING