Mailing-List: contact allura-commits-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: allura-dev@incubator.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: brondsem@apache.org
To: allura-commits@incubator.apache.org
Date: Tue, 17 Sep 2013 19:12:12 -0000
Message-Id: <d01d01a6fcbe4e8689ceb5a1b4f597ef@git.apache.org>
In-Reply-To: <4aab4676f6694722aef845f79aa45d5b@git.apache.org>
References: <4aab4676f6694722aef845f79aa45d5b@git.apache.org>
Subject: [14/20] git commit: [#5966] start adding docs for our scripts

[#5966] start adding docs for our scripts


Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/0951bee7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/0951bee7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/0951bee7

Branch: refs/heads/db/5822
Commit: 0951bee782d45d365763863ce570118d26b9c09a
Parents: 21b2c16
Author: Dave Brondsema <dbrondsema@slashdotmedia.com>
Authored: Thu Sep 12 18:44:50 2013 +0000
Committer: Cory Johns <cjohns@slashdotmedia.com>
Committed: Tue Sep 17 17:00:13 2013 +0000

----------------------------------------------------------------------
 Allura/docs/administration.rst | 66 +++++++++++++++++++++++++++++++++++++
 Allura/docs/index.rst          |  1 +
 2 files changed, 67 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/0951bee7/Allura/docs/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/administration.rst b/Allura/docs/administration.rst
new file mode 100644
index 0000000..b58339f
--- /dev/null
+++ b/Allura/docs/administration.rst
@@ -0,0 +1,66 @@
+..     Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+
+Administration
+=================
+
+Commands, Scripts, and Tasks
+----------------------------
+
+Allura has many `paster` commands and `paster` scripts that can be run from the
+server commandline to administrate Allura.  There are also tasks that can be
+run through the `taskd` system.  New tasks can be submitted via the web at
+/nf/admin/task_manager  Some paster commands and scripts have been set up
+so that they are runnable as tasks too, giving you the convenience of starting
+them through the web and letting `taskd` execute them, rather than from a server
+shell.
+
+Commands can be discovered and run via the `paster` command when you are in the
+'Allura' directory that has your .ini file.  For example::
+
+    (env-allura) Allura$ paster help
+    ... all commands listed here ...
+
+    (env-allura) Allura$ paster create-neighborhood --help
+    ... specific command help ...
+
+    (env-allura) Allura$ paster create-neighborhood development.ini myneighborhood myuser ...
+
+
+Scripts are in the `scripts/` directory and run via `paster script`.  An extra
+`--` is required to separate script arguments from paster arguments.  Example::
+
+    (env-allura) Allura$ paster script development.ini ../scripts/create-allura-sitemap.py -- --help
+    ... help output ...
+
+    (env-allura) Allura$ paster script development.ini ../scripts/create-allura-sitemap.py -- -u 100
+
+
+TODO: explain how to run tasks, explain important scripts, commands and tasks here
+
+
+Client Scripts
+--------------
+
+Allura includes some client scripts that use Allura APIs and do not have to be run
+from an Allura server.  They do require various python packages to be installed
+and possibly a local Allura codebase set up.
+
+One such script is `wiki-copy.py` which reads the wiki pages from one Allura wiki
+instance and uploads them to another Allura wiki instance.  It can be run as::
+
+$ python scripts/wiki-copy.py --help

http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/0951bee7/Allura/docs/index.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/index.rst b/Allura/docs/index.rst
index 877b98d..ebbd0bf 100644
--- a/Allura/docs/index.rst
+++ b/Allura/docs/index.rst
@@ -35,6 +35,7 @@ Getting Started
    :maxdepth: 2
 
    installation
+   administration
    platform_tour
    scm_host
    migration