Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Commit

Permalink
Include documentation for admin
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Eng committed May 12, 2015
1 parent 847501d commit cadd86e
Show file tree
Hide file tree
Showing 16 changed files with 143 additions and 14 deletions.
Binary file added docs/images/admin-manage-search.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin-monitoring.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin-process-manager.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin-settings-client.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin-settings-email-log.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin-settings-general.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin-settings-piwik.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin-statistics.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/release-notes.md
Expand Up @@ -2,7 +2,7 @@

<h5>Infrastructure Changes</h5>

* Zanata now uses Infinispan as its cache provider, and the cache needs to be configured in Jboss' `standalone.xml` file. Please see the [Infinispan](configuration/infinispan) section for more information.
* Zanata now uses Infinispan as its cache provider, and the cache needs to be configured in Jboss' `standalone.xml` file. Please see the [Infinispan](user-guide/system-admin/configuration/infinispan) section for more information.

* This release adds a one-time migration of some data, which can cause a timeout during server startup. This applies to
all plain text and libreoffice formats, so is only a concern for servers that are upgrading from an earlier version and
Expand Down
34 changes: 21 additions & 13 deletions docs/user-guide/admin/admin-overview.md
Expand Up @@ -13,43 +13,51 @@ To access to admin menu, login to Zanata with admin role user, select `Administr
</figure>
<br/>

## Server configuration
### Server configuration

Configuration and settings for Zanata server.

## Manage users
See [server configuration](user-guide/admin/server-config) for more information.

### Manage users

- Edit user information such as password, roles.
- Delete users in Zanata.


## Manage Roles
### Manage Roles

- Create new roles to Zanata.
- Edit/Remove roles in Zanata.

## Manage Search
### Manage Search

Reindexing Zanata database used for searching.

- Reindexing Zanata database used for searching.
See [Manage search](user-guide/admin/manage-search) for more information.

## Role assignment rules
### Role assignment rules

See [Role assignment rules](user-guide/admin/role-assignment-rules) for more information.

## Translation memory
### Translation memory

- Import/Export external TMX file for translation memory in editor.

## Process manager
### Process manager

- See all background asynchronous tasks running in Zanata.
All background asynchronous tasks running in Zanata.

## Overall statistic
See [Process manager](user-guide/admin/process-manager) for more information.

### Overall statistic

Overall general statistics of Zanata.

- Number of users, projects, documents and translations.
See [Statistic](user-guide/admin/statistic) for more information.

### Server monitoring

## Server monitoring
Server performance and statistics.

- Server performance and statistics.
See [Monitoring](user-guide/admin/monitoring) for more information.
23 changes: 23 additions & 0 deletions docs/user-guide/admin/manage-search.md
@@ -0,0 +1,23 @@
<figure>
<img alt="Process manager" src="images/admin-manage-search.png" />
</figure>
<br/>

Zanata uses lucene index for fast searching and perform various tasks such as translation memory search.

### Purge index

Mark all existing index entries for the table obsolete. Obsolete entries still occupy disk space but are not returned in any searches.

### Reindex

Index all rows in the given table. Rows will be indexed automatically when data is persisted, so this operation is only necessary when the index is out-of-date (e.g. when the database has been restored from backup, after a failed reindex, if index files have been removed).

All rows of the given table will be reindexed regardless whether they already have an entry in the index. Rows that have already been indexed will have their entries updated, which will usually have no effect on the entry.

**Warning:** This operation can take hours for large tables, and will increase memory use significantly above baseline. It is strongly recommended to run this operation during off-peak times when average server memory use is at a minimum.

### Optimize

This arrange index entries to maximize search speed and also removes any obsolete entries from the index.
This operation will not influence indexing time.
7 changes: 7 additions & 0 deletions docs/user-guide/admin/monitoring.md
@@ -0,0 +1,7 @@
<figure>
<img alt="Monitoring" src="images/admin-monitoring.png" />
</figure>
<br/>

* Zanata uses [Java Melody](https://code.google.com/p/javamelody/) for performance and statistic monitoring.

8 changes: 8 additions & 0 deletions docs/user-guide/admin/process-manager.md
@@ -0,0 +1,8 @@
All asynchronous tasks that are running in the background are shown in this page.

<figure>
<img alt="Process manager" src="images/admin-process-manager.png" />
</figure>
<br/>

* Admin also have the authority to terminate any running process shown in this page.
64 changes: 64 additions & 0 deletions docs/user-guide/admin/server-config.md
@@ -0,0 +1,64 @@
## General

General configuration for Zanata server.

<figure>
<img alt="Admin settings general" src="images/admin-settings-general.png" />
</figure>
<br/>

1. Server URL - The base URL for Zanata server including the application context path.
2. Register URL - The user registration URL for the server.
3. Email Domain name - Domain name used for email address.
4. Contact Admin address - Email address for Zanata admin.
5. From Email Address - Email address of 'From' field in all email sent from Zanata.
6. Terms of Use URL - URL for terms of use statement.
7. Help URL - URL for help page.



------

## Email log

This enables or disables the sending of Zanata diagnostics log information via email.

<figure>
<img alt="Admin settings email log" src="images/admin-settings-email-log.png" />
</figure>
<br/>

1. To enable, click on `Enabled` checkbox.
1. Select log level to send email. `Error` will only send error messages, while `Warning` will send both warning and error messages.
1. Fill in email address (comma separate for multiple email address) in provided text field.
1. Click `Save` at the bottom of the page for save changes.


------

## Piwik

[Piwik](http://piwik.org/) is a web analytics tools application. It tracks online visits to one or more websites and displays reports on these visits for analysis.

<figure>
<img alt="Admin settings piwik" src="images/admin-settings-piwik.png" />
</figure>
<br/>

1. Fill in your hosted piwik url and id to enable Piwik.


------

## Client

Admin can control the limit of client communication towards server via Client or REST API.

<figure>
<img alt="Admin settings client" src="images/admin-settings-client.png" />
</figure>
<br/>

1. Max concurrent requests per API key - Once over the limit server will return status code 403. 0 means no limit. Default(blank) is 6.
1. Max active requests per API key - Request may block. 0 means no limit. Default(blank) is 2. If this is greater than max concurrent request limit, it will have no effect.
1. Max files per upload - Maximum number of files a user can queue for upload in the web upload dialog.
11 changes: 11 additions & 0 deletions docs/user-guide/admin/statistic.md
@@ -0,0 +1,11 @@
<figure>
<img alt="Statistic" src="images/admin-statistics.png" />
</figure>
<br/>

This page shows the number of

- translators and reviewers in Zanata
- projects and versions hosted in Zanata
- documents uploaded to Zanata
- translations in Zanata
8 changes: 8 additions & 0 deletions mkdocs.yml
Expand Up @@ -10,6 +10,7 @@ use_directory_urls: false

pages:
- ['index.md', 'Home']
- ['release-notes.md', 'Release notes', 'Release notes']
# Getting started
- ['user-guide/translator-guide.md', 'Getting Started', 'Translator Guide']
- ['user-guide/project-maintainer-guide.md', 'Getting Started', 'Project Maintainer Guide']
Expand Down Expand Up @@ -77,7 +78,13 @@ pages:
## Admin
- ['user-guide/admin/admin-overview.md', 'Admin', 'Overview']
- ['user-guide/admin/contact-admin.md', 'Admin', 'Contact Admin']
- ['user-guide/admin/server-config.md', 'Admin', 'Server configuration']
- ['user-guide/admin/manage-search.md', 'Admin', 'Manage search']
- ['user-guide/admin/process-manager.md', 'Admin', 'Process manager']
- ['user-guide/admin/role-assignment-rules.md', 'Admin', 'Role assignment rules']
- ['user-guide/admin/statistic.md', 'Admin', 'Statistic']
- ['user-guide/admin/monitoring.md', 'Admin', 'Monitoring']
## TODO: tmx, Manage users, Manage roles
# System admin
- ['user-guide/system-admin/configuration/installation.md', 'System Admin', 'Installation']
- ['user-guide/system-admin/configuration/authentication.md', 'System Admin', 'Authentication']
Expand All @@ -87,6 +94,7 @@ pages:
- ['user-guide/system-admin/configuration/infinispan.md', 'System Admin', 'Caches']
- ['user-guide/system-admin/configuration/jms-messaging.md', 'System Admin', 'JMS Messaging']

# UI bug, last entry does not show in the list, using it to push JMS Messaging up
- ['release-notes.md']

copyright: Copyright &copy; 2015, <a href="http//www.redhat.com">Red Hat</a>.

0 comments on commit cadd86e

Please sign in to comment.