rave-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ja...@apache.org
Subject svn commit: r1189188 - in /incubator/rave/site/trunk/content/rave: documentation/ images/
Date Wed, 26 Oct 2011 13:14:28 GMT
Author: jasha
Date: Wed Oct 26 13:14:28 2011
New Revision: 1189188

URL: http://svn.apache.org/viewvc?rev=1189188&view=rev
Log:
Document admin interface

Added:
    incubator/rave/site/trunk/content/rave/documentation/admin-interface-users.mdtext
    incubator/rave/site/trunk/content/rave/documentation/admin-interface-widgets.mdtext
    incubator/rave/site/trunk/content/rave/documentation/admin-interface.mdtext
    incubator/rave/site/trunk/content/rave/images/screenshot-admin-userdetails.png   (with
props)
    incubator/rave/site/trunk/content/rave/images/screenshot-admin-widgetdetails.png   (with
props)

Added: incubator/rave/site/trunk/content/rave/documentation/admin-interface-users.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/documentation/admin-interface-users.mdtext?rev=1189188&view=auto
==============================================================================
--- incubator/rave/site/trunk/content/rave/documentation/admin-interface-users.mdtext (added)
+++ incubator/rave/site/trunk/content/rave/documentation/admin-interface-users.mdtext Wed
Oct 26 13:14:28 2011
@@ -0,0 +1,43 @@
+Title:     Portal Admin interface: Users
+Notice:    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.
+
+A portal administrator is able to manage account data of other users:
+
+  - Email address
+  - OpenId URL
+
+It is currently not possible to change the username or password of a user.
+
+To access the admin interface, see [Portal admin interface](admin-interface.html).
+
+## Account status
+
+A User is able to login if his account is `enabled`, not `expired` and not `locked`. These
properties can be managed
+through the admin interface.
+
+Note: an admin cannot disable, expire or lock his own account through the admin interface
+
+## Authorities
+
+The following authorities are defined for the portal:
+
+  - `ROLE_USER`: a user with this role can view portal pages
+  - `ROLE_ADMIN`: a user with this role can view the portal pages and use the admin interface
+
+
+![Screenshot of user details in admin interface](/rave/images/screenshot-admin-userdetails.png)

Added: incubator/rave/site/trunk/content/rave/documentation/admin-interface-widgets.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/documentation/admin-interface-widgets.mdtext?rev=1189188&view=auto
==============================================================================
--- incubator/rave/site/trunk/content/rave/documentation/admin-interface-widgets.mdtext (added)
+++ incubator/rave/site/trunk/content/rave/documentation/admin-interface-widgets.mdtext Wed
Oct 26 13:14:28 2011
@@ -0,0 +1,43 @@
+Title:     Portal Admin interface: Widgets
+Notice:    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.
+
+Portal admins are able to update the stored metadata of widgets: URL of the actual widget,
its availability in the portal, thumbnail etc.
+
+To access the admin interface, see [Portal admin interface](admin-interface.html).
+
+## Overview
+
+The list of widgets will be growing. In the admin interface it's possible to filter widgets
on status (`preview`, `published`), type (`OpenSocial`, `W3C Widget`) or a free text search
in the widget's title and description. All search criteria are optional.
+
+Only widgets that are marked as `published` will appear in the portal widget store. If a
user adds a new widget, its status is set to `preview`
+
+## Widget metadata
+
+  - Title: the title that is used in the widget store
+  - Location: the URL for the widget definition
+  - Type: defines which widget provider should be used for rendering the widget
+  - Description: shown in the widget store
+  - Status: defines if the widget is available in the store (in the future it will be possible
to block a gadget)
+  - Thumbnail: shown in the widget store listing
+  - Screenshot: gives the user an idea how the widget will look like. Shown on the widget
detail page in the widget store.
+  - URL the gadget title links to: if filled in, the title of the rendered gadget will link
to this URL
+  - Author: will be shown in the widget store
+  - Author email: can be used to contact the author, currently not shown in the widget store
+  
+
+![Screenshot of Widget metadata](screenshot-admin-widgetdetails.png)
\ No newline at end of file

Added: incubator/rave/site/trunk/content/rave/documentation/admin-interface.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/documentation/admin-interface.mdtext?rev=1189188&view=auto
==============================================================================
--- incubator/rave/site/trunk/content/rave/documentation/admin-interface.mdtext (added)
+++ incubator/rave/site/trunk/content/rave/documentation/admin-interface.mdtext Wed Oct 26
13:14:28 2011
@@ -0,0 +1,29 @@
+Title:     Portal Admin interface
+Notice:    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.
+
+The Rave Portal has an admin interface to manage data from [users][1] and [widgets][2] (version
0.5-INCUBATING).
+In the future it may also support manage group data, show portal usage statistics or change
the look and feel of the portal.
+
+## Access the admin interface
+
+The address of the admin interface is [http://localhost:8080/portal/app/admin/].  
+User `canonical` (password: `canonical`) is the only user with admin privileges. Other users
will not be able to go to the admin interface.
+
+
+[1]: admin-interface-users.html
+[2]: admin-interface-widgets.html
\ No newline at end of file

Added: incubator/rave/site/trunk/content/rave/images/screenshot-admin-userdetails.png
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/images/screenshot-admin-userdetails.png?rev=1189188&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/rave/site/trunk/content/rave/images/screenshot-admin-userdetails.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/rave/site/trunk/content/rave/images/screenshot-admin-widgetdetails.png
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/images/screenshot-admin-widgetdetails.png?rev=1189188&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/rave/site/trunk/content/rave/images/screenshot-admin-widgetdetails.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream



Mime
View raw message