incubator-allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [1/4] git commit: [#5966] start adding docs for our scripts
Date Tue, 17 Sep 2013 17:03:03 GMT
Updated Branches:
  refs/heads/master a1779fa8d -> 1e8670ebb

[#5966] start adding docs for our scripts


Branch: refs/heads/master
Commit: 0951bee782d45d365763863ce570118d26b9c09a
Parents: 21b2c16
Author: Dave Brondsema <>
Authored: Thu Sep 12 18:44:50 2013 +0000
Committer: Cory Johns <>
Committed: Tue Sep 17 17:00:13 2013 +0000

 Allura/docs/administration.rst | 66 +++++++++++++++++++++++++++++++++++++
 Allura/docs/index.rst          |  1 +
 2 files changed, 67 insertions(+)
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
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+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
+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/
-- --help
+    ... help output ...
+    (env-allura) Allura$ paster script development.ini ../scripts/
-- -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 `` 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/ --help
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
+   administration

View raw message