allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [09/17] allura git commit: [#7999] ticket:857 Add documentation
Date Wed, 25 Nov 2015 19:38:03 GMT
[#7999] ticket:857 Add documentation


Branch: refs/heads/master
Commit: e6fceed8184040da500cd58c73419260e80d6093
Parents: 350d8f4
Author: Igor Bondarenko <>
Authored: Wed Nov 4 19:16:36 2015 +0200
Committer: Dave Brondsema <>
Committed: Wed Nov 25 14:37:42 2015 -0500

 Allura/allura/scripts/       |  6 +--
 Allura/docs/getting_started/administration.rst | 44 ++++++++++++++++++++-
 2 files changed, 46 insertions(+), 4 deletions(-)
diff --git a/Allura/allura/scripts/ b/Allura/allura/scripts/
index cedf87b..1c53b76 100644
--- a/Allura/allura/scripts/
+++ b/Allura/allura/scripts/
@@ -96,11 +96,11 @@ class DeleteProjects(ScriptTask):
     def parser(cls):
         parser = argparse.ArgumentParser(description='Completely delete projects')
         parser.add_argument('projects', metavar='nbhd/project', type=str, nargs='+',
-                            help='Project to delete in a form nbhd_prefix/shortname')
+                            help='List of projects to delete in a form nbhd_prefix/shortname')
         parser.add_argument('-r', '--reason', type=str,
-                            help='Reason why these projects being deleted')
+                            help='Reason why these projects are being deleted')
         parser.add_argument('--disable-users', action='store_true', default=False,
-                            help='Disable all project members')
+                            help='Disable all users belonging to groups Admin and Developer
in these projects.')
         return parser
diff --git a/Allura/docs/getting_started/administration.rst b/Allura/docs/getting_started/administration.rst
index 8673840..bd9aef3 100644
--- a/Allura/docs/getting_started/administration.rst
+++ b/Allura/docs/getting_started/administration.rst
@@ -35,6 +35,7 @@ The admin interface allows you to:
 * View newly registered projects
 * Search for projects
+* :ref:`Delete projects <delete-projects>`
 * View neighborhood total stats
 * Search for users, view user details, update user status, email address, and reset their
 * View background task statuses, and submit new background tasks
@@ -76,7 +77,7 @@ Scripts are in the `scripts/` directory and run slightly differently, via
      paster script development.ini ../scripts/ -- -u 100
-To run these when using docker, prefix with :code:`docker-compose run web` and use :code:`docker-dev.ini`
+To run these when using docker, prefix with :code:`docker-compose run taskd` and use :code:`docker-dev.ini`
     docker-compose run taskd paster create-neighborhood docker-dev.ini myneighborhood myuser
@@ -175,6 +176,21 @@
     :prog: paster script development.ini allura/scripts/ --
+.. _delete-projects-py:
+*Can be run as a background task using task name:* :code:`allura.scripts.delete_projects.DeleteProjects`
+More convenient way to delete project is :ref:`this site admin page <delete-projects>`.
It uses this script under the hood.
+.. argparse::
+    :module: allura.scripts.delete_projects
+    :func: get_parser
+    :prog: paster script development.ini allura/scripts/ --
@@ -274,6 +290,32 @@ indefinitely (until closed).  The notification content can contain HTML.
 Only t
 most recent notification will be shown, unless it has `active:false`, in which case
 no notification will be shown.
+.. _delete-projects:
+Deleting projects
+Site administrators can delete projects using web interface. This is running
+:ref:` script <delete-projects-py>` under the hood. You can
+access it choosing "Delete projects" from the left sidebar on the :ref:`site
+admin interface <site-admin-interface>`.
+**Be careful, projects and all related data are actually deleted from the database!**
+Just copy and paste URLs of the project you want to delete into "Projects"
+field. You can also use :code:`nbhd_prefix/project_shortname` format, e.g.
+.. code-block:: text
+  http://MYSITE/p/test/wiki/
+  p/test2
+will delete projects :code:`test` and :code:`test2`.
+The "Reason" field allows you to specify a reason for deletion, which will be logged to disk.
+"Disable all project members" checkbox disables all users belonging to groups "Admin" and
"Developer" in these projects. The reason will be also recorded in the users' audit logs if
this option is checked.
 Using Projects and Tools

View raw message