allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jetm...@apache.org
Subject [9/9] allura git commit: [#8024] ticket:884 Amend docs
Date Fri, 08 Jan 2016 10:43:19 GMT
[#8024] ticket:884 Amend docs


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

Branch: refs/heads/ib/8024a
Commit: f77e858382bdd22ddee16a0888d6aa46b13cd921
Parents: 4dbf67f
Author: Igor Bondarenko <jetmind2@gmail.com>
Authored: Fri Jan 8 12:42:10 2016 +0200
Committer: Igor Bondarenko <jetmind2@gmail.com>
Committed: Fri Jan 8 12:42:10 2016 +0200

----------------------------------------------------------------------
 Allura/docs/getting_started/administration.rst | 32 +++++++++++----------
 1 file changed, 17 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/allura/blob/f77e8583/Allura/docs/getting_started/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/administration.rst b/Allura/docs/getting_started/administration.rst
index c6d23cb..50a3f0f 100644
--- a/Allura/docs/getting_started/administration.rst
+++ b/Allura/docs/getting_started/administration.rst
@@ -42,6 +42,7 @@ The admin interface allows you to:
 * Manage "trove" categories (for user skill choices)
 * Subscribe a user to an artifact
 * Reclone a repository
+* :ref:`Manage site notifications <site-notifications>`
 
 Customizing appearance
 ======================
@@ -301,34 +302,35 @@ Requires running: :command:`pip install suds` first. ::
 
     usage: paster script development.ini ../scripts/teamforge-import.py -- --help
 
+.. _site-notifications:
 
 Site Notifications
 ==================
 
-Allura has support for site-wide notifications that appear below the site header,
-but there is currently no UI for managing them.  They can easily be inserted via
-manual mongo queries, however:
+Allura has support for site-wide notifications that appear below the site
+header.  UI for managing them can be found under "Site Notifications" in the
+left sidebar on the :ref:`site admin interface <site-admin-interface>`.
+
+For example, setting available options to:
 
 .. code-block:: console
 
-    > db.site_notification.insert({
-    ... active: true,
-    ... impressions: 10,
-    ... content: 'You can now reimport exported project data.',
-    ... user_role: 'Developer',
-    ... page_regex: '(Home|browse_pages)',
-    ... page_tool_type: 'wiki'
-    ... })
+    Active:      ✓
+    Impressions: 10
+    Content:     You can now reimport exported project data.
+    User Role:   Developer
+    Page Regex:  (Home|browse_pages)
+    Page Type:   wiki
 
-This will create a notification that will be shown for 10 page views or until
+will create a notification that will be shown for 10 page views or until
 the user closes it manually.  The notification will be shown only for users
 which have role 'Developer' or higher in one of their projects.  And if url of
 the current page is matching regex :code:`(Home|browse_pages)` and app
-tool type is :code:`wiki`.  An :code:`impressions` value of 0 will show the
+tool type is :code:`wiki`.  An "Impressions" value of 0 will show the
 notification indefinitely (until closed).  The notification content can contain
 HTML.  Only the most recent notification will be shown, unless it has
-:code:`active:false`, in which case no notification will be shown.
-:code:`user_role`, :code:`page_regex` and :code:`page_tool_type` are optional.
+"Active" unchecked, in which case no notification will be shown.
+"User Role", "Page Regex" and "Page Type" are optional.
 
 .. _delete-projects:
 


Mime
View raw message