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

Commit

Permalink
Merge pull request #845 from zanata/updateImageDoc
Browse files Browse the repository at this point in the history
Update image doc
  • Loading branch information
Alex Eng committed Jun 3, 2015
2 parents dfb1488 + bbcce40 commit 5578463
Show file tree
Hide file tree
Showing 43 changed files with 150 additions and 206 deletions.
5 changes: 3 additions & 2 deletions docs/user-guide/account/account-activate.md
Expand Up @@ -8,7 +8,8 @@ To activate your account:
1. If you didn't receive an email from Zanata, see [Resend activation email](user-guide/account/account-resend-activation).
1. Click the `Account activation link` in your email or copy and paste the URL provided into your browser.
1. You will be redirected to Zanata with your account activated. You can now log in with your details.

<img alt="Account activated" src="images/account-activated.png" />
<figure>
![Account activated](/images/account-activated.png)
</figure>

*Note: The activation URL will expire after 24 hours.*
5 changes: 3 additions & 2 deletions docs/user-guide/account/account-resend-activation.md
Expand Up @@ -6,5 +6,6 @@ If you didn't receive an email after signing up, or entered wrong email address
1. You will be redirected to `account inactive` page.
1. To resend activation email to the same email address, click on `Resend activation email` button.
1. To update email address and send activation email, enter the new email address in the input field and click `Update email`.

<img alt="Resend activation or update email address" src="images/account-resend-activation.png" />
<figure>
![Resend activation or update email address](/images/account-resend-activation.png)
</figure>
19 changes: 10 additions & 9 deletions docs/user-guide/account/account-settings.md
@@ -1,27 +1,27 @@
# Account Settings

To access your user settings:

1. Login to Zanata
1. Click on `User menu` on top right corner, click on `Settings` on the drop down menu.
1. Alternatively, you can click on the `Settings` tab on your dashboard page.

## Account Settings
## Settings

### Update email

1. Enter the new email address in input field and click `Update email`.

<img alt="Email input field" src="images/account-settings-email.png" />
<figure>
![Email input field](/images/account-settings-email.png)
</figure>

1. A confirmation email will be sent to the new email address. Click on the link or the URL to confirm email address change.

### Change password

1. Fill in the `Old Password` and `New Password` fields.
<figure>
![Password input field](/images/account-settings-password.png)
</figure>

<img alt="Password input field" src="images/account-settings-password.png" />

1. Click `Update password` to change your password.

### Merge with other account
Expand All @@ -38,8 +38,9 @@ Use this to merge additional Zanata accounts you may have created when signing u
## Languages

This page shows all the language teams you have joined in Zanata.

<img alt="Languages" src="images/account-settings-languages.png" />
<figure>
![Languages](/images/account-settings-languages.png)
</figure>

To join more language teams,

Expand Down
5 changes: 3 additions & 2 deletions docs/user-guide/account/account-sign-up.md
Expand Up @@ -16,8 +16,9 @@ To create an account using OpenID:
1. Complete the `Name`, `Username`, and `Email` fields. Ensure your email address is entered correctly.
1. Click `Save`. This sends a validation email to the address you entered in the previous step.
1. Open the validation email and click the validation link.

<img alt="Account signup openid" src="images/account-signup-openid-details.png" />
<figure>
![Account signup openid](/images/account-signup-openid-details.png)
</figure>

You can now sign in to Zanata using your OpenID credentials.

Expand Down
15 changes: 9 additions & 6 deletions docs/user-guide/account/user-dashboard.md
Expand Up @@ -7,8 +7,9 @@ The dashboard aims to help you quickly see and navigate to content that is relev
## Opening the Dashboard

If you sign in from the Zanata homepage, the first screen you see will be the user dashboard. To get to the dashboard from another page, expand the user menu on the right and click `Dashboard`.

<img alt="User dashboard menu" src="images/user-dashboard.png" />
<figure>
![User dashboard menu](/images/user-dashboard.png)
</figure>

## Dashboard Information

Expand All @@ -20,8 +21,9 @@ Dashboard has
- an activity stream
- list of maintained projects
- [Profile settings](user-guide/account/account-settings)

<img alt="User dashboard" src="images/user-dashboard-view.png" />
<figure>
![User dashboard](/images/user-dashboard-view.png)
</figure>

### User Information

Expand All @@ -44,5 +46,6 @@ If you have more recent activity than is shown in the activity stream, you can s
### Projects

In the Project tab, a list of your maintained projects is shown. The down arrow to the left of the version can be clicked to show all the versions for the project. The project name, version name link directly to the project page, version page respectively.

<img alt="User dashboard" src="images/user-dashboard-versions.png" />
<figure>
![User dashboard version](/images/user-dashboard-versions.png)
</figure>
10 changes: 6 additions & 4 deletions docs/user-guide/account/user-profile.md
@@ -1,8 +1,10 @@
You can view a user's profile page by typing the username in the top search field and click on the search result.

<img alt="Project user search" src="images/project-user-search.png" />
<figure>
![Project user search](/images/project-user-search.png)
</figure>

On the user profile page, you can view this user's recent contribution statistics according to the selected date range option.
By default it will show this week's contribution categorized by language and project.

<img alt="User profile" src="images/user-profile.png" />
<figure>
![User profile](/images/user-profile.png)
</figure>
5 changes: 2 additions & 3 deletions docs/user-guide/admin/admin-overview.md
Expand Up @@ -2,14 +2,13 @@ Zanata admin has full access to all functionality in Zanata.

To access to admin menu, login to Zanata with admin role user, select `Administrator`.
<figure>
<img alt="admin menu access" src="images/admin-menu-access.png" />
![admin menu access](/images/admin-menu-access.png)
</figure>
<br/>

## Admin sections

<figure>
<img alt="admin sections" src="images/admin-sections.png" />
![admin sections](/images/admin-sections.png)
</figure>
<br/>

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/admin/contact-admin.md
@@ -1,11 +1,11 @@
1. Login to Zanata.
1. At the bottom of the page, click on `Contact admin`.
<figure>
<img alt="Contact admin link" src="images/admin-contact-link.png" />
![Contact admin link](/images/admin-contact-link.png)
</figure>
<br/>
1. In the dialog, fill in the message in the input file and click `Send`.
<figure>
<img alt="Contact admin" src="images/admin-contact.png" />
![Contact admin](/images/admin-contact.png)
</figure>
<br/>
4 changes: 1 addition & 3 deletions docs/user-guide/admin/manage-search.md
@@ -1,6 +1,4 @@
<figure>
<img alt="Process manager" src="images/admin-manage-search.png" />
</figure>
![Manage search](/images/admin-manage-search.png)
<br/>

Zanata uses lucene index for fast searching and perform various tasks such as translation memory search.
Expand Down
4 changes: 1 addition & 3 deletions docs/user-guide/admin/monitoring.md
@@ -1,6 +1,4 @@
<figure>
<img alt="Monitoring" src="images/admin-monitoring.png" />
</figure>
![Monitoring](/images/admin-monitoring.png)
<br/>

* Zanata uses [Java Melody](https://code.google.com/p/javamelody/) for performance and statistic monitoring.
Expand Down
3 changes: 1 addition & 2 deletions docs/user-guide/admin/process-manager.md
@@ -1,7 +1,6 @@
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" />
![Process manager](/images/admin-process-manager.png)
</figure>
<br/>

Expand Down
14 changes: 6 additions & 8 deletions docs/user-guide/admin/role-assignment-rules.md
@@ -1,16 +1,14 @@
'Role assignment rules' are Zanata's way of dynamically assigning security roles and even Project access to users.
To configure Role Assignment Rules, admin users must go to the Administration section and click 'Role assignment rules' button.

<figure>
<img alt="Role Assignment Rules Location" src="images/role-assignment-access.png" />
![Role Assignment Rules Location](/images/role-assignment-access.png)
</figure>
<br/>


### Overview

<figure>
<img alt="Role Assignment Rules overview" src="images/role-assignment-view.png" />
![Role Assignment Rules overview](/images/role-assignment-view.png)
</figure>
<br/>

Expand All @@ -33,12 +31,12 @@ To configure Role Assignment Rules, admin users must go to the Administration se
1. Navigate to 'Role assignment rules' page.
1. Click on `More Action` menu on the top right panel.
<figure>
<img alt="Role Assignment Rules new" src="images/role-assignment-new-access.png" />
![Role Assignment Rules new](/images/role-assignment-new-access.png)
</figure>
<br/>
1. Select `New Rule`.
<figure>
<img alt="Role Assignment Rules new form" src="images/role-assignment-new-form.png" />
![Role Assignment Rules new form](/images/role-assignment-new-form.png)
</figure>
<br/>
1. Fill in the fields and click `Save`.
Expand All @@ -49,7 +47,7 @@ To configure Role Assignment Rules, admin users must go to the Administration se
1. Locate the rule you wish to delete, click on `Options` menu in front of the row.
1. Click `Delete` to remove the rule.
<figure>
<img alt="Role Assignment delete" src="images/role-assignment-delete.png" />
![Role Assignment delete](/images/role-assignment-delete.png)
</figure>
<br/>

Expand All @@ -63,7 +61,7 @@ To restrict project access,
1. Click on `Permission` tab.
1. Check `Restrict access to certain user roles` and select roles that you wish to allow access to your project.
<figure>
<img alt="Role Assignment project" src="images/role-assignment-project.png" />
![Role Assignment project](/images/role-assignment-project.png)
</figure>
<br/>
1. Any role restrictions will now be seen on the project's page and only users belonging to that role will be able to work on the project.
12 changes: 4 additions & 8 deletions docs/user-guide/admin/server-config.md
@@ -1,9 +1,8 @@
## General

General configuration for Zanata server.

<figure>
<img alt="Admin settings general" src="images/admin-settings-general.png" />
![Admin settings general](/images/admin-settings-general.png)
</figure>
<br/>

Expand All @@ -22,9 +21,8 @@ General configuration for Zanata server.
## 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" />
![Admin settings email log](/images/admin-settings-email-log.png)
</figure>
<br/>

Expand All @@ -39,9 +37,8 @@ This enables or disables the sending of Zanata diagnostics log information via e
## 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" />
![Admin settings piwik](/images/admin-settings-piwik.png)
</figure>
<br/>

Expand All @@ -53,9 +50,8 @@ This enables or disables the sending of Zanata diagnostics log information via e
## 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" />
![Admin settings client](/images/admin-settings-client.png)
</figure>
<br/>

Expand Down
4 changes: 1 addition & 3 deletions docs/user-guide/admin/statistic.md
@@ -1,6 +1,4 @@
<figure>
<img alt="Statistic" src="images/admin-statistics.png" />
</figure>
![Statistic](/images/admin-statistics.png)
<br/>

This page shows the number of
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/documents/download-translated-documents.md
Expand Up @@ -11,13 +11,13 @@ Zanata allows anyone to download translations from a project version.

1. On the right panel, click on the drop down menu, select `Download All(zip)`.
<figure>
<img alt="Download all translation files" src="images/version-download-translations-all.png" />
![Download all translation files](/images/version-download-translations-all.png)
</figure>
<br/>

1. Click on `Download` button to start downloading.
<figure>
<img alt="Download all translation files dialog" src="images/version-download-translations-all-dialog.png" />
![Download all translation files dialog](/images/version-download-translations-all-dialog.png)
</figure>
<br/>

Expand All @@ -26,7 +26,7 @@ Zanata allows anyone to download translations from a project version.
1. Click on the drop down menu located in front of a document.
1. Select `Download translated [supported file format]`.
<figure>
<img alt="Download translation file" src="images/version-download-translations.png" />
![Download translation file](/images/version-download-translations.png)
</figure>

### From client
Expand Down
14 changes: 7 additions & 7 deletions docs/user-guide/documents/upload-documents.md
Expand Up @@ -13,11 +13,11 @@ You will need to [Create a project](user-guide/projects/create-project) and [Cre
#### Uploading new source documents

1. Go to `Documents` tab, click on down arrow on top of Document panel.
<img alt="Upload source document" src="images/upload-new-source-doc.png" />
![Upload source document](/images/upload-new-source-doc.png)
1. Select `Upload new source document`.
1. Browse or Drag your documents into the dialog and click `Upload Documents`.
1. You can access the same dialog in by go to `Settings` tab -> `Documents` section. Click `+` sign on top left panel.
<img alt="Upload source document dialog" src="images/upload-source-doc-dialog.png" />
![Upload source document dialog](/images/upload-source-doc-dialog.png)
<br/>

#### Updating existing source documents
Expand All @@ -26,7 +26,7 @@ You will need to [Create a project](user-guide/projects/create-project) and [Cre
1. Select your file and choose the source language for this file.
1. Click `Upload` to proceed.

<img alt="Upload source document" src="images/upload-source-doc.png" />
![Upload source document](/images/upload-source-doc.png)

*Alternatively*

Expand All @@ -35,18 +35,18 @@ You will need to [Create a project](user-guide/projects/create-project) and [Cre
1. Select your file and choose the source language for this file.
1. Click `Upload` to proceed.

<img alt="Upload source document from settings" src="images/upload-source-doc-from-settings.png" />
![Upload source document from settings](/images/upload-source-doc-from-settings.png)


#### Uploading translation documents

1. Click on `Languages` tab in version page, select the language of translation document you wish to upload.
1. On right panel, click on the down arrow(Translation option) on left side of document and select `Upload translation`.

<img alt="Upload translation document" src="images/upload-translation-doc.png" />

![Upload translation document](/images/upload-translation-doc.png)
<br/>

<img alt="Upload translation document dialog" src="images/upload-translation-doc-dialog.png" />
![Upload translation document dialog](/images/upload-translation-doc-dialog.png)

1. On the dialog, select your translation file.
- `Merge` option - If unchecked, uploaded translations overrides current translation, otherwise, it will merge with current translation in system.
Expand Down
10 changes: 3 additions & 7 deletions docs/user-guide/editor/documents-view.md
@@ -1,6 +1,4 @@
<figure>
<img alt="Documents view" src="images/editor-doc-list.png" />
</figure>
![Documents view](/images/editor-doc-list.png)
<br/>

1. **Breadcrumbs** - Links to Project -> Version
Expand All @@ -12,9 +10,8 @@
7. **Paging** - Page navigation for document list.

## Settings

<figure>
<img alt="Documents view settings" src="images/editor-doc-list-settings.png" />
![Documents view settings](/images/editor-doc-list-settings.png)
</figure>
<br/>

Expand All @@ -26,9 +23,8 @@


## Validations

<figure>
<img alt="Documents view settings" src="images/editor-doc-list-validations.png" />
![Editor doc list validations](/images/editor-doc-list-validations.png)
</figure>
<br/>

Expand Down

0 comments on commit 5578463

Please sign in to comment.