allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brond...@apache.org
Subject [4/7] allura git commit: [#5943] ticket:815 Describe project templates
Date Mon, 13 Jul 2015 18:15:18 GMT
[#5943] ticket:815 Describe project templates


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

Branch: refs/heads/master
Commit: 5f3e726e58dc021b623bd444fa7a56add7ff8f9d
Parents: a3d8785
Author: Igor Bondarenko <jetmind2@gmail.com>
Authored: Fri Jul 10 12:29:12 2015 +0300
Committer: Dave Brondsema <dbrondsema@slashdotmedia.com>
Committed: Mon Jul 13 18:14:37 2015 +0000

----------------------------------------------------------------------
 Allura/docs/getting_started/using.rst | 45 +++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/allura/blob/5f3e726e/Allura/docs/getting_started/using.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/using.rst b/Allura/docs/getting_started/using.rst
index e16c36f..1425dde 100644
--- a/Allura/docs/getting_started/using.rst
+++ b/Allura/docs/getting_started/using.rst
@@ -48,7 +48,50 @@ This interface allows you to:
 Project Templates
 ^^^^^^^^^^^^^^^^^
 
-TODO
+Allows to specify a template for newly created projects. The template controls default tools,
permissions, labels, etc for a project. It is formatted as JSON dictionary with the following
structure:
+
+.. code-block:: javascript
+
+  {
+    "private": false,
+    "tools": {
+        "tool_name": {               /* e.g. wiki, git, tickets, etc */
+          "label": "Tool Label",     /* Required */
+          "mount_point": "url-path"  /* Required */
+          "options": {}              /* Any other tool's options here. Optional */
+        }
+    },
+    "groups": [
+      {
+        "name": "Admin",        /* Default groups are: Admin, Developer, Member */
+        "usernames": ["admin1"] /* Add existing users to existing group */
+      },
+      {
+        "name": "New Group",     /* You can also create a new group */
+        "usernames": ["user1"],  /* and add existing users to it */
+        /*
+         * Then you need to specify permissions for newly created group.
+         * Supported permissions are: admin, create, update, read
+         */
+        "permissions": ["read", "update"]
+      }
+    ],
+    "tool_order": ["wiki", "tickets", "git"], /* tools order in the topbar menu */
+    "labels": ["Open Source", "web"],
+    "trove_cats": {
+      /*
+       * Available trove types are: root_database, license, developmentstatus,
+       * audience, os, language, topic, natlanguage, environment.
+       */
+      "trove_type": [905, 869]  /* TroveCategory ids */
+    },
+    "icon": {
+      "url: "http://img.host/path/to/image.png",  /* Required */
+      "filename": "default-project-icon.png"      /* Required */
+    }
+  }
+
+Top level keys are optional.
 
 .. _anchored-tools:
 


Mime
View raw message