diff --git a/docs/user-guide/account/account-activate.md b/docs/user-guide/account/account-activate.md index 0e84b98271..7cb76c3d6b 100644 --- a/docs/user-guide/account/account-activate.md +++ b/docs/user-guide/account/account-activate.md @@ -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. - -Account activated +
+ ![Account activated](/images/account-activated.png) +
*Note: The activation URL will expire after 24 hours.* \ No newline at end of file diff --git a/docs/user-guide/account/account-resend-activation.md b/docs/user-guide/account/account-resend-activation.md index 5feac71063..1d472e3c52 100644 --- a/docs/user-guide/account/account-resend-activation.md +++ b/docs/user-guide/account/account-resend-activation.md @@ -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`. - -Resend activation or update email address \ No newline at end of file +
+ ![Resend activation or update email address](/images/account-resend-activation.png) +
\ No newline at end of file diff --git a/docs/user-guide/account/account-settings.md b/docs/user-guide/account/account-settings.md index 54aa2610ff..9ce7856d9f 100644 --- a/docs/user-guide/account/account-settings.md +++ b/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`. - - Email input field +
+ ![Email input field](/images/account-settings-email.png) +
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. +
+ ![Password input field](/images/account-settings-password.png) +
- Password input field - 1. Click `Update password` to change your password. ### Merge with other account @@ -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. - -Languages +
+ ![Languages](/images/account-settings-languages.png) +
To join more language teams, diff --git a/docs/user-guide/account/account-sign-up.md b/docs/user-guide/account/account-sign-up.md index a23538085b..91ce5ff04e 100644 --- a/docs/user-guide/account/account-sign-up.md +++ b/docs/user-guide/account/account-sign-up.md @@ -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. - -Account signup openid +
+ ![Account signup openid](/images/account-signup-openid-details.png) +
You can now sign in to Zanata using your OpenID credentials. diff --git a/docs/user-guide/account/user-dashboard.md b/docs/user-guide/account/user-dashboard.md index 2dc296db56..e3ace86c4d 100644 --- a/docs/user-guide/account/user-dashboard.md +++ b/docs/user-guide/account/user-dashboard.md @@ -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`. - -User dashboard menu +
+ ![User dashboard menu](/images/user-dashboard.png) +
## Dashboard Information @@ -20,8 +21,9 @@ Dashboard has - an activity stream - list of maintained projects - [Profile settings](user-guide/account/account-settings) - -User dashboard +
+ ![User dashboard](/images/user-dashboard-view.png) +
### User Information @@ -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. - -User dashboard +
+ ![User dashboard version](/images/user-dashboard-versions.png) +
diff --git a/docs/user-guide/account/user-profile.md b/docs/user-guide/account/user-profile.md index 6d9232aa03..9cceb153d0 100644 --- a/docs/user-guide/account/user-profile.md +++ b/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. - -Project user search +
+ ![Project user search](/images/project-user-search.png) +
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. - -User profile +
+ ![User profile](/images/user-profile.png) +
diff --git a/docs/user-guide/admin/admin-overview.md b/docs/user-guide/admin/admin-overview.md index d1e1536b99..887ebdbdd9 100644 --- a/docs/user-guide/admin/admin-overview.md +++ b/docs/user-guide/admin/admin-overview.md @@ -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`.
-admin menu access +![admin menu access](/images/admin-menu-access.png)

## Admin sections -
-admin sections +![admin sections](/images/admin-sections.png)

diff --git a/docs/user-guide/admin/contact-admin.md b/docs/user-guide/admin/contact-admin.md index 3a90eb87e1..e438616117 100644 --- a/docs/user-guide/admin/contact-admin.md +++ b/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`.
-Contact admin link +![Contact admin link](/images/admin-contact-link.png)

1. In the dialog, fill in the message in the input file and click `Send`.
-Contact admin +![Contact admin](/images/admin-contact.png)

\ No newline at end of file diff --git a/docs/user-guide/admin/manage-search.md b/docs/user-guide/admin/manage-search.md index 52f9a70deb..7d0ea5e60f 100644 --- a/docs/user-guide/admin/manage-search.md +++ b/docs/user-guide/admin/manage-search.md @@ -1,6 +1,4 @@ -
-Process manager -
+![Manage search](/images/admin-manage-search.png)
Zanata uses lucene index for fast searching and perform various tasks such as translation memory search. diff --git a/docs/user-guide/admin/monitoring.md b/docs/user-guide/admin/monitoring.md index 4a7868d6eb..e452273b15 100644 --- a/docs/user-guide/admin/monitoring.md +++ b/docs/user-guide/admin/monitoring.md @@ -1,6 +1,4 @@ -
-Monitoring -
+![Monitoring](/images/admin-monitoring.png)
* Zanata uses [Java Melody](https://code.google.com/p/javamelody/) for performance and statistic monitoring. diff --git a/docs/user-guide/admin/process-manager.md b/docs/user-guide/admin/process-manager.md index f915482a36..064eb75dd7 100644 --- a/docs/user-guide/admin/process-manager.md +++ b/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. -
-Process manager +![Process manager](/images/admin-process-manager.png)

diff --git a/docs/user-guide/admin/role-assignment-rules.md b/docs/user-guide/admin/role-assignment-rules.md index 86d5db7413..5b98d68950 100644 --- a/docs/user-guide/admin/role-assignment-rules.md +++ b/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. -
-Role Assignment Rules Location +![Role Assignment Rules Location](/images/role-assignment-access.png)

### Overview -
-Role Assignment Rules overview +![Role Assignment Rules overview](/images/role-assignment-view.png)

@@ -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.
-Role Assignment Rules new +![Role Assignment Rules new](/images/role-assignment-new-access.png)

1. Select `New Rule`.
-Role Assignment Rules new form +![Role Assignment Rules new form](/images/role-assignment-new-form.png)

1. Fill in the fields and click `Save`. @@ -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.
-Role Assignment delete +![Role Assignment delete](/images/role-assignment-delete.png)

@@ -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.
-Role Assignment project +![Role Assignment project](/images/role-assignment-project.png)

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. \ No newline at end of file diff --git a/docs/user-guide/admin/server-config.md b/docs/user-guide/admin/server-config.md index 14f5d08981..2a0c7c49f4 100644 --- a/docs/user-guide/admin/server-config.md +++ b/docs/user-guide/admin/server-config.md @@ -1,9 +1,8 @@ ## General General configuration for Zanata server. -
-Admin settings general +![Admin settings general](/images/admin-settings-general.png)

@@ -22,9 +21,8 @@ General configuration for Zanata server. ## Email log This enables or disables the sending of Zanata diagnostics log information via email. -
-Admin settings email log +![Admin settings email log](/images/admin-settings-email-log.png)

@@ -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. -
-Admin settings piwik +![Admin settings piwik](/images/admin-settings-piwik.png)

@@ -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. -
-Admin settings client +![Admin settings client](/images/admin-settings-client.png)

diff --git a/docs/user-guide/admin/statistic.md b/docs/user-guide/admin/statistic.md index 604d5064a0..dc70c68b05 100644 --- a/docs/user-guide/admin/statistic.md +++ b/docs/user-guide/admin/statistic.md @@ -1,6 +1,4 @@ -
-Statistic -
+![Statistic](/images/admin-statistics.png)
This page shows the number of diff --git a/docs/user-guide/documents/download-translated-documents.md b/docs/user-guide/documents/download-translated-documents.md index 50693fa5b7..1453605d36 100644 --- a/docs/user-guide/documents/download-translated-documents.md +++ b/docs/user-guide/documents/download-translated-documents.md @@ -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)`.
-Download all translation files +![Download all translation files](/images/version-download-translations-all.png)

1. Click on `Download` button to start downloading.
-Download all translation files dialog +![Download all translation files dialog](/images/version-download-translations-all-dialog.png)

@@ -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]`.
-Download translation file +![Download translation file](/images/version-download-translations.png)
### From client diff --git a/docs/user-guide/documents/upload-documents.md b/docs/user-guide/documents/upload-documents.md index 17e5949169..b2b9c577ea 100644 --- a/docs/user-guide/documents/upload-documents.md +++ b/docs/user-guide/documents/upload-documents.md @@ -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. -Upload source document +![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. -Upload source document dialog +![Upload source document dialog](/images/upload-source-doc-dialog.png)
#### Updating existing source documents @@ -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. -Upload source document +![Upload source document](/images/upload-source-doc.png) *Alternatively* @@ -35,7 +35,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. -Upload source document from settings +![Upload source document from settings](/images/upload-source-doc-from-settings.png) #### Uploading translation documents @@ -43,10 +43,10 @@ You will need to [Create a project](user-guide/projects/create-project) and [Cre 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`. -Upload translation document - +![Upload translation document](/images/upload-translation-doc.png) +
-Upload translation document dialog +![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. diff --git a/docs/user-guide/editor/documents-view.md b/docs/user-guide/editor/documents-view.md index ae0c5fe8dd..148052e75e 100644 --- a/docs/user-guide/editor/documents-view.md +++ b/docs/user-guide/editor/documents-view.md @@ -1,6 +1,4 @@ -
-Documents view -
+![Documents view](/images/editor-doc-list.png)
1. **Breadcrumbs** - Links to Project -> Version @@ -12,9 +10,8 @@ 7. **Paging** - Page navigation for document list. ## Settings -
-Documents view settings +![Documents view settings](/images/editor-doc-list-settings.png)

@@ -26,9 +23,8 @@ ## Validations -
-Documents view settings +![Editor doc list validations](/images/editor-doc-list-validations.png)

diff --git a/docs/user-guide/editor/editor-view.md b/docs/user-guide/editor/editor-view.md index bdd56fadae..91aeffa651 100644 --- a/docs/user-guide/editor/editor-view.md +++ b/docs/user-guide/editor/editor-view.md @@ -1,6 +1,4 @@ -
-Editor view -
+![Editor view](/images/editor-overview.png)
### 1. Breadcrumbs @@ -77,16 +75,14 @@ If a glossary has been uploaded for your language, each word in the currently se If you're not part of that language team, the editor will open as readonly mode. You will be restricted to only viewing source and translations in the editor. -
-Readonly editor +![Readonly editor](/images/editor-readonly-indicator.png)

## Settings -
-Editor settings +![Editor settings](/images/editor-settings.png)

@@ -102,9 +98,8 @@ You will be restricted to only viewing source and translations in the editor. ## Validations -
-Editor validation settings +![Editor validation settings](/images/editor-validations.png)

diff --git a/docs/user-guide/editor/overview.md b/docs/user-guide/editor/overview.md index 952c2b655a..e2f4dc641b 100644 --- a/docs/user-guide/editor/overview.md +++ b/docs/user-guide/editor/overview.md @@ -4,9 +4,8 @@ See [Translator guide](user-guide/translator-guide) for more information. ## Views in webtrans -
-View icons +![View icons](/images/editor-views-icon.png)

diff --git a/docs/user-guide/editor/translation-history.md b/docs/user-guide/editor/translation-history.md index e9d52517b1..ea35116408 100644 --- a/docs/user-guide/editor/translation-history.md +++ b/docs/user-guide/editor/translation-history.md @@ -2,17 +2,15 @@ User will be able to see translation history of each messages. It will display f ### How to show translation history In editor click on the "timer" like icon below will bring up the initial view: -
-Translation history +![Translation history](/images/editor-history-button.png)

### Comparison of two entries If selecting exactly two entries, user will be able to compare them in a diff view: -
-Translation history comparison +![Translation history comparison](/images/editor-translation-history-comparison.png)

diff --git a/docs/user-guide/glossary/delete-glossaries.md b/docs/user-guide/glossary/delete-glossaries.md index 2a3591902d..edb10360bc 100644 --- a/docs/user-guide/glossary/delete-glossaries.md +++ b/docs/user-guide/glossary/delete-glossaries.md @@ -6,7 +6,7 @@ Requires **Glossary-admin** role. See [glossary roles and permission](user-guide 1. Click `Glossary` on menu. 1. Click on `Glossary options` on the glossary language you wish to delete and click `Delete glossary`.
- Glossary options +![Glossary options](/images/glossary-options.png)
1. Click `OK` to confirm delete all glossary entries in selected locale. diff --git a/docs/user-guide/glossary/edit-glossaries.md b/docs/user-guide/glossary/edit-glossaries.md index a7e9d7d4c9..4d53174aa9 100644 --- a/docs/user-guide/glossary/edit-glossaries.md +++ b/docs/user-guide/glossary/edit-glossaries.md @@ -5,13 +5,13 @@ See [glossary roles and permission](user-guide/glossary/glossary-roles-permissio translation editor can be found at [Preparing for Translation](user-guide/translator-guide#start-translate-a-project-version). 1. In Glossary panel (bottom right corner), click on icon on the glossary entry you wish to edit.
- glossary panel -
Glossary panel
+![Glossary panel](/images/glossary-panel.png) +
Glossary panel
- +
- glossary entry window -
Glossary entry windows
+![glossary entry window](/images/glossary-edit-windows.png) +
Glossary entry windows
1. In the popup window, user can: diff --git a/docs/user-guide/glossary/upload-glossaries.md b/docs/user-guide/glossary/upload-glossaries.md index f563be59fd..e85213f8cf 100644 --- a/docs/user-guide/glossary/upload-glossaries.md +++ b/docs/user-guide/glossary/upload-glossaries.md @@ -21,8 +21,8 @@ See [glossary roles and permission](user-guide/glossary/glossary-roles-permissio 1. part-of-speech column: The part-of-speech is an informational field that indicates the sense in which the terms in the row should be used. Sample parts-of-speech include adjective, adverb, noun, and verb. 1. description column: The description should provide any notes for the translator, including the meaning of the terms in the row.
- sample glossary csv file -
Valid glossary csv file
+![sample glossary csv file](/images/glossary-csv.png) +
Valid glossary csv file
### Upload via Web UI @@ -31,18 +31,18 @@ See [glossary roles and permission](user-guide/glossary/glossary-roles-permissio 1. Click `Glossary` menu. 1. Click on `More Actions` on top right corner of the table, follow by `Upload glossary` from the list.
- More action in glossary page -
More actions in glossary table
+![More action in glossary page](/images/glossary-upload.png) +
More actions in glossary table
1. A window will popup, click on `choose file` to select your glossary file.
- Glossary upload window +![Glossary upload window](/images/glossary-upload-windows.png)
1. For PO file format, you will need to select **Source and Target languages** of the selected po file.
- Glossary upload window, PO file +![Glossary upload window, PO file](/images/glossary-upload-windows-po.png)
1. Click `Upload` button to start uploading selected glossary file. diff --git a/docs/user-guide/groups/create-group.md b/docs/user-guide/groups/create-group.md index 6d9b98acf8..d3b3302270 100644 --- a/docs/user-guide/groups/create-group.md +++ b/docs/user-guide/groups/create-group.md @@ -4,13 +4,12 @@ Currently, only admin can create a group: 1. Click on `Groups` section on the top menu. 1. Click on 'New Group' button on right panel.
- New group menu + ![New group menu](/images/create-group.png)
The following screenshot shows the group creation page. -
-Group create form +![Group create form](/images/create-group-completed.png)
Example filled in group creation form
diff --git a/docs/user-guide/groups/group-settings.md b/docs/user-guide/groups/group-settings.md index a8658b725b..7e9b58bc95 100644 --- a/docs/user-guide/groups/group-settings.md +++ b/docs/user-guide/groups/group-settings.md @@ -1,7 +1,7 @@ Once a group has been created, the maintainer can add further details and group behaviour via the Settings tab. See the [Group Creation Help](user-guide/groups/create-group) for details on creating groups.
-Groups General Settings tab +![Groups General Settings](/images/group-settings-button.png)
Groups Settings tab link.
@@ -9,9 +9,8 @@ See the [Group Creation Help](user-guide/groups/create-group) for details on cre ## General Settings The General tab contains fields that manage appearance your group which already covered in the [Group Creation Help](user-guide/groups/create-group). -
-Group General Settings tab +![Group General Settings tab](/images/group-general-settings.png)
Group General Settings tab

@@ -24,9 +23,8 @@ This button is used to set a group to read-only, which prevents the group being ------------ ## Languages Settings -
-Groups Languages Settings tab +![Groups Languages Settings tab](/images/group-languages-settings.png)
Groups Languages Settings tab

@@ -45,9 +43,8 @@ To remove a language from the list of available locales, first move the cursor o ------------ ## Projects Settings -
-Groups Projects Settings tab +![Groups Projects Settings tab](/images/group-projects-settings.png)
Groups Projects Settings tab

@@ -62,14 +59,14 @@ To add a version to your group, select the desired project version from the drop ### Remove a project version To remove a project version from the list, first move the cursor over the project version, then click the "X" that appears. -Groups projects remove + +![Groups projects remove](/images/group-projects-remove.png) ------------ ## Maintainers Settings -
-Groups Maintainer Settings tab +![Groups Maintainer Settings tab](/images/group-maintainer-settings.png)
Group Maintainer Settings tab

diff --git a/docs/user-guide/groups/group-view.md b/docs/user-guide/groups/group-view.md index 15c3b0ceb9..ffc637ab57 100644 --- a/docs/user-guide/groups/group-view.md +++ b/docs/user-guide/groups/group-view.md @@ -1,7 +1,6 @@ When a group is selected, you will be taken to an overall view of the group. This will show a list of the available versions as well as an indication of their translation progress. -
-Group view language tab +![Group view language tab](/images/group-view-languages.png)
Group View

diff --git a/docs/user-guide/languages/add-team-member.md b/docs/user-guide/languages/add-team-member.md index bd222c3430..827874d10e 100644 --- a/docs/user-guide/languages/add-team-member.md +++ b/docs/user-guide/languages/add-team-member.md @@ -6,7 +6,7 @@ While signed-in as language coordinator 1. Click the language team. 1. Click on `+` sign on the top left panel.
-Add new member +![Add new member](/images/language-add-member.png)

1. Enter username and click `Search`. diff --git a/docs/user-guide/languages/language-team.md b/docs/user-guide/languages/language-team.md index be7e9dedf7..cd5a979287 100644 --- a/docs/user-guide/languages/language-team.md +++ b/docs/user-guide/languages/language-team.md @@ -12,12 +12,12 @@ While signed-in, translators can join a Language Team by completing the followin 1. Click the language team you want to join. 1. Click on `More Action` menu on top right panel, select `Request to Join Team`.
-Request to join menu +![Request to join menu](/images/language-request-join-menu.png)

1. In the dialog, select roles you wish to be added as, fill in some information for language team coordinator and click `Send`.
-Request to join menu +![Request to join](/images/language-request-join.png)

@@ -30,7 +30,8 @@ While signed-in, translators can leave a Language Team by completing the followi 1. Click `Language` tab. 1. Click the language team you want to leave. 1. Click on `More Action` menu on top right panel, select `Leave Language Team`. -Request to leave + +![Request to leave](/images/language-leave-team.png) ## Contact Language Coordinator @@ -40,10 +41,10 @@ Any user in Zanata can contact language coordinator by: 1. Click on a language team. 1. Click on `More Action` menu on top right panel, select `Contact Coordinators`.
-Contact coordinator menu +![Contact coordinator menu](/images/language-contact-menu.png)

1. In the dialog, fill in the message in the input file and click `Send`.
-Contact coordinator +![Contact coordinator](/images/language-contact-coordinator.png)
\ No newline at end of file diff --git a/docs/user-guide/languages/modify-role.md b/docs/user-guide/languages/modify-role.md index d53cf7eddc..9694272379 100644 --- a/docs/user-guide/languages/modify-role.md +++ b/docs/user-guide/languages/modify-role.md @@ -3,8 +3,7 @@ To modify role for existing user 1. Click `Languages` tab. 1. Click the language team. 1. In members tab, locate the user in the list, and check on the relevant role you wish to add. -
-Language members tab +![Language members tab](/images/language-members-tab.png)

\ No newline at end of file diff --git a/docs/user-guide/projects/create-project.md b/docs/user-guide/projects/create-project.md index f580b3b542..9fd42ff0f8 100644 --- a/docs/user-guide/projects/create-project.md +++ b/docs/user-guide/projects/create-project.md @@ -9,17 +9,15 @@ Anyone with an account can upload source strings to Zanata. The first step is to ## Project creation through the website To start creating a project on the Zanata website, click the `New Project` button on the `Projects` page. -
-Project creation button on Projects page +![Project creation button on Projects page](/images/create-project.png)
Project creation button on `Projects` page.

The following screenshot shows the project creation page. In the screenshot, all fields have been filled in to illustrate the process. This example would create a project with a URL ending in '/zanata-server', that will be displayed in the project list as 'Zanata Server'. Details for each of the fields are shown below. -
-Example project creation form with all fields filled in +![Example project creation form with all fields filled in](/images/create-project-completed.png)
Example filled in project creation form
diff --git a/docs/user-guide/projects/project-settings.md b/docs/user-guide/projects/project-settings.md index 1044c03ad1..ec806c5ffe 100644 --- a/docs/user-guide/projects/project-settings.md +++ b/docs/user-guide/projects/project-settings.md @@ -1,7 +1,7 @@ Once a project has been created, the maintainer can add further details and project behaviour via the Settings tab. See the [Project Creation Help](user-guide/projects/create-project) for details on creating projects.
-Project General Settings tab +![Project General Settings tab](/images/project-settings-button.png)
Project Settings tab link.
@@ -10,9 +10,8 @@ The Settings tab contains fields that manage appearance and workflow of your pro ------------ ## General Settings -
-Project General Settings tab +![Project General Settings tab](/images/project-general-settings.png)
Project General Settings tab

@@ -48,9 +47,8 @@ This can be toggled using the same button, as desired. ------------ ## Languages Settings -
-Project Languages Settings tab +![Project Languages Settings tab](/images/project-languages-settings.png)
Project Languages Settings tab

@@ -65,9 +63,8 @@ By default, your project will be available for translation to all of the enabled To search for available languages, enter text into the field under "Add a language". Available languages matching the entered text will display in a dropdown. To add add a language to your project, select the desired language from the dropdown. -
-Adding a project language +![Adding a project language](/images/project-languages-add.png)
Adding a project language
@@ -75,18 +72,16 @@ To add add a language to your project, select the desired language from the drop ### Remove a Language To remove a language from the list of available locales, first move the cursor over the language, then click the "X" that appears. -
-Removing a project language +![Removing a project language](/images/project-languages-remove.png)
Removing a project language
------------ ## Translation Settings -
-Project Translation Settings tab +![Project Translation Settings tab](/images/project-translation-settings.png)
Project Translation Settings tab
@@ -111,9 +106,8 @@ Refer to [the Copy Translations reference](user-guide/translation-reuse/copy-tra ------------ ## Permissions Settings -
-Project Permissions Settings tab +![Project Permissions Settings tab](/images/project-permissions-settings.png)
Project Permissions Settings tab

@@ -134,9 +128,8 @@ The access restriction feature is intended for use with special roles that can b ------------ ## Webhooks -
-Project Webhooks Settings tab +![Project Webhooks Settings tab](/images/project-webhooks-settings.png)
Project Webhooks Settings tab
@@ -149,15 +142,14 @@ When an event occurs, Zanata will make a HTTP POST to the URI configured in the ### Adding a Webhook URI -Project Webhooks Settings tab +![Project Webhooks Settings tab](/images/project-webhooks-settings-2.png) Enter a valid URI into the provided text input. Hit the 'enter' key or click on 'Add webhook' button to add the URI. ------------ ## About -
-Project About Settings tab +![Project About Settings tab](/images/project-about-settings.png)
Project About Settings tab

diff --git a/docs/user-guide/projects/project-view.md b/docs/user-guide/projects/project-view.md index da4740faf6..564add5168 100644 --- a/docs/user-guide/projects/project-view.md +++ b/docs/user-guide/projects/project-view.md @@ -1,7 +1,6 @@ When a project is selected, you will be taken to an overall view of the project. This will show a list of the available versions as well as an indication of their translation progress. -
-Project view version tab +![Project view version tab](/images/project-view-versions.png)
Project View

diff --git a/docs/user-guide/review/translation-review.md b/docs/user-guide/review/translation-review.md index 8ccca40556..421b2eab9b 100644 --- a/docs/user-guide/review/translation-review.md +++ b/docs/user-guide/review/translation-review.md @@ -8,9 +8,8 @@ The review process is about reading translations in the 'translated' state and d ## Ready for review Translations are considered ready for review when they have 'translated' state, which is shown as green bars on either side of the translation string. -
-Translated strings +![Translated strings](/images/editor-translated-strings.png)

@@ -18,9 +17,8 @@ Translations are considered ready for review when they have 'translated' state, ## Filtering the view If only some of the translations are in 'translated' state, such as if the document is only partially translated or has already been through an initial review, it may be helpful to filter the view so that only 'translated' strings are shown. This is done by checking `Translated` state in the `Complete` category near the top of the editor. -
-Filter translated strings +![Filter translated strings](/images/editor-filter-translated.png)

@@ -30,18 +28,16 @@ If only some of the translations are in 'translated' state, such as if the docum ## Accept and Reject buttons If you have review permission for a document, you will see an extra pair of buttons next to each editor cell to accept or reject the translation. You will have review permission if you are a reviewer for the language, or if you are a maintainer for the project. Maintainers may wish to review strings to make sure they are correctly formatted for the environment, particularly for software translations. -
-Editor approved button +![Editor approved button](/images/editor-approve-button.png)

## Accepting Translations If you decide a translation is acceptable and does not need any change, it can be approved simply by pressing the `Accept translation` button next to the editor window. This will change the state to `Approved`. -
-Editor approved string +![Editor approved string](/images/editor-approved.png)

@@ -53,34 +49,30 @@ Approved state is is shown as blue bars on either side of the translation string If a translation is not yet acceptable, it can be rejected so that translators know that it needs to be changed. To reject a translation click the `Reject translation` button next to the editor window. This will open a dialog where you can enter the reason for the rejection. -
-Editor approved string +![Editor reject dialog](/images/editor-reject-dialog.png)

You must enter a reason for rejecting the translation - the `Confirm rejection` will not work until a reason has been entered. This is to make sure that translators can make the right changes so that the translation is acceptable, rather than trying to guess why it was rejected. Rejected state is shown as orange bars on either side of the translation string. You will also notice an indicator on the top right of the text area showing that there is a comment. Clicking the comment indicator will open the history view where the comment is shown. -
-Editor rejected string +![Editor rejected string](/images/editor-rejected-with-comment.png)

You can also open the history view by clicking the `History` button on the right. -
-Editor rejected string +![Editor history button](/images/editor-history-button.png)

When a translation is rejected, the reason for the rejection is shown as a comment in history view, with the `Rejected` state shown above it. There is also a space where additional comments can be added. This may be useful for discussing a rejected translation, but keep in mind that at the time of writing, reviewers do not yet receive any notification when there is a new comment on a rejected translation. -
-Editor rejected history +![Editor rejected history](/images/editor-rejected-history.png)

diff --git a/docs/user-guide/translation-reuse/copy-trans.md b/docs/user-guide/translation-reuse/copy-trans.md index 07d76bd91b..a16e9c68ac 100644 --- a/docs/user-guide/translation-reuse/copy-trans.md +++ b/docs/user-guide/translation-reuse/copy-trans.md @@ -29,18 +29,16 @@ This process is repeated for each text flow in the uploaded document, or, if Cop #### Permissive Options If `Continue` is selected for all conditions, only the required "On content mismatch" rule is checked. This means that if a string has matching content it bypasses all other conditions and is reused in a "Translated" state (or "Approved" if your project requires review and the translation being copied is already in "Approved" state). When there are multiple matches, the latest translation is used. -
-Copy trans permissive options +![Copy trans permissive options](/images/copy-trans-permissive.png)

#### Strict Options If `Don't Copy` is selected for all conditions, a string must have matching content, a matching ID, be from the same project, and be from a document with the same name and path, otherwise it will not be reused. If all of the conditions are passed, the content is reused in a "Translated" state (or "Approved" if your project requires review and the translation being copied is already in "Approved" state). -
-Copy trans strict options +![Copy trans strict options](/images/copy-trans-strict.png)

@@ -51,9 +49,8 @@ For this example, consider that you have a new version of your project in Zanata 1. To ensure that Copy Trans uses strings from the other version in your project only, set "On project mismatch" to `Don't Copy`. 1. To ensure that the changed document paths do not affect the reuse process, set "On document mismatch" to `Continue`. 1. Because most string IDs have not changed, set "On Context mismatch" to `Continue as Fuzzy`. -
-Copy trans new version +![Copy trans new version](/images/copy-trans-newversion.png)

@@ -64,14 +61,13 @@ You can run Copy Trans manually against a project version. 1. On the project version page, click on `More actions` menu on the top right.
-Copy trans access +![Copy trans access](/images/copy-trans-access.png)

1. Select `Copy Translations`. 1. Select the appropriate action for each condition, and then click `Copy Translations` button. -
-Copy trans dialog +![Copy trans dialog](/images/copy-trans-dialog.png)

diff --git a/docs/user-guide/translation-reuse/copy-version.md b/docs/user-guide/translation-reuse/copy-version.md index db2c10654d..9680efd806 100644 --- a/docs/user-guide/translation-reuse/copy-version.md +++ b/docs/user-guide/translation-reuse/copy-version.md @@ -13,9 +13,8 @@ When [creating new version](user-guide/versions/create-version), project maintai 1. Select the version you wish to copy from. In the screen shot below, this will create a new version **0.3** and copying all information and history from version **0.2**. -
-Copy version +![Copy version](/images/copy-version.png)

@@ -26,12 +25,12 @@ A progress bar on the version page will displays the progress of the operation. 1. Go to `Version` tab in your project page. 1. Locate the version you wish to branch off, click on the menu in front of the version and select `Copy to new version`.
-Copy version access +![Copy version access](/images/copy-version-access.png)

1. The same menu can access by going to the version page, and click on `More action` menu on the top right. Select `Copy to new version`.
-Copy version access +![Copy version access](/images/copy-version-access2.png)

1. This will redirect you to [Create a new version](user-guide/versions/create-version) with pre-selected version. diff --git a/docs/user-guide/translation-reuse/merge-trans.md b/docs/user-guide/translation-reuse/merge-trans.md index 45228d0714..be107f656d 100644 --- a/docs/user-guide/translation-reuse/merge-trans.md +++ b/docs/user-guide/translation-reuse/merge-trans.md @@ -9,12 +9,12 @@ If there is an existing translate/approved translations, the newer translation w 1. Navigate to the project version page you wish to merge translations to. 1. Click on `More action` menu on the top right. Select `Merge translations`.
-Merge translation access +![Merge translation access](/images/merge-trans-access.png)

1. In popup windows, select your project and version that you want to copy translation from.
-Merge translation +![Merge translation](/images/merge-trans-dialog.png)

1. `Keep existing translated/approved translations` - select if you do not want to merge translation to replace existing translated/approved translations with newer translations from this source. diff --git a/docs/user-guide/translator-guide.md b/docs/user-guide/translator-guide.md index 2fb6d03adc..af27006d65 100644 --- a/docs/user-guide/translator-guide.md +++ b/docs/user-guide/translator-guide.md @@ -10,7 +10,7 @@ Any translator who has joined a language team can participate in the document tr 1. In project page, locate the version you wish to translate. 1. Click on `Options` and select `Translate in {your language}`.
-Start translate +![Start translate](/images/webtrans-access.png)

@@ -22,8 +22,7 @@ Any translator who has joined a language team can participate in the document tr 1. In project page, click on the version you wish to translate. 3. In version page, open up the language page (default page) and select a language. 4. Click on the document name to open up the [editor](user-guide/editor/editor-view). -
-Select document +![Select document](/images/editor-open-menu.png)

\ No newline at end of file diff --git a/docs/user-guide/versions/create-version.md b/docs/user-guide/versions/create-version.md index c1d4345922..6acd2086d2 100644 --- a/docs/user-guide/versions/create-version.md +++ b/docs/user-guide/versions/create-version.md @@ -14,11 +14,11 @@ For simple projects, it is typical to create a single version named 'master'. Ot To add a version to your project, navigate to the project using the menu or user dashboard, go to `Version` tab, click on `More action` and select `New Version`. If your project has no versions yet, there will be a link under the project on the user dashboard to jump straight to version creation. -![Version creation button on a project homepage](images/version-create.png) +![Version creation button on a project homepage](/images/version-create.png) Version creation button on a project homepage. -![Shortcut version creation link on user dashboard](images/user-dashboard-create-version.png) +![Shortcut version creation link on user dashboard](/images/user-dashboard-create-version.png) Shortcut version creation link on user dashboard. @@ -26,7 +26,7 @@ Shortcut version creation link on user dashboard. The following screenshot shows the version creation page. The settings in this screenshot will create a version under the 'zanata-server' project with ID 'master', that does not require a review phase for translations and will use the locales and validations from the project. See below for details on each option. -![Example version creation form with completed name and other settings](images/version-create-new.png) +![Example version creation form with completed name and other settings](/images/version-create-new.png) ### Version ID diff --git a/docs/user-guide/versions/merge-translations.md b/docs/user-guide/versions/merge-translations.md index 727b19a0dc..d9a2551475 100644 --- a/docs/user-guide/versions/merge-translations.md +++ b/docs/user-guide/versions/merge-translations.md @@ -33,17 +33,17 @@ Merge translations allows project maintainers to copy translations across differ 1. Select a project version you wish to copy translations to. 1. Expand `More Action` menu on top right corner and click on `Merge Translations`. This action is only available if you are a maintainer of the project.
- More action menu in project version page +![More action menu in project version page](/images/version-more-action-menu.png)
1. In displayed dialog, select the project-version you wish to copy translations from.
- Merge translation dialog +![Merge translation dialog](/images/version-merge-trans-dialog.png)
1. If you do not want to overwrite translated/approved translations, ensure that `Keep existing translated/approved translations` is checked. If this option is not checked, translated/approved translations will be replaced with newer translated/approved translations if they are available. 1. Click `Merge Translations` button to start the process. 1. The progress of the merge process is shown by a progress bar on the version page.
- Merge translation in progress +![Merge translation in progress](/images/version-merge-trans-progress.png)
## Cancel Merge translation @@ -52,7 +52,7 @@ Merge translations allows project maintainers to copy translations across differ 1. Go to the progress bar section in project version page. 1. Click on the `Cancel` button on top right panel.
- Cancel merge translation in progress +![Cancel merge translation in progress](/images/version-merge-trans-cancel.png)
diff --git a/docs/user-guide/versions/request-to-join-group.md b/docs/user-guide/versions/request-to-join-group.md index 7588a9fd0c..bead21d520 100644 --- a/docs/user-guide/versions/request-to-join-group.md +++ b/docs/user-guide/versions/request-to-join-group.md @@ -3,11 +3,11 @@ Project maintainer can request for their project version to be part of certain G 1. Navigate to the group page you wish to join. 2. On the right panel, click on the drop down menu, and select "Request to add a project version to {{Group name}}".
- Request to join group + ![Request to join group](/images/group-request-join.png)

3. In the dialog, search and click from the drop down for your maintained project, and check the version you wish to join into the group. 4. Fill in `Additional information` for group maintainer and click `Send`.
- Request to join group + ![Request to join group](/images/group-request-join-dialog.png)
\ No newline at end of file diff --git a/docs/user-guide/versions/version-settings.md b/docs/user-guide/versions/version-settings.md index b49b090871..71956093ee 100644 --- a/docs/user-guide/versions/version-settings.md +++ b/docs/user-guide/versions/version-settings.md @@ -1,16 +1,15 @@ Once a version has been created, the maintainer can add further details and version behaviour via the Settings tab. See the [Version Creation Help](user-guide/versions/create-version) for details on creating version.
-Version General Settings tab +![Version General Settings tab](/images/version-settings-button.png)
Versions Settings tab link.
------------ ## General Settings -
-Version General Settings tab +![Version General Settings tab](/images/version-general-settings.png)
Version General Settings tab

@@ -28,9 +27,8 @@ This can be toggled using the same button, as desired. ------------ ## Documents Settings -
-Version Documents Settings tab +![Version Documents Settings tab](/images/version-documents-settings.png)
Version Documents Settings tab
@@ -43,9 +41,8 @@ Click `+` sign on top left in Documents tab under Settings. Browse or Drag your ------------ ## Languages Settings -
-Version Languages Settings tab +![Version Languages Settings tab](/images/version-languages-settings.png)
Version Languages Settings tab
@@ -58,9 +55,8 @@ By default, your project will be available for translation to a set of locales d ------------ ## Translation Settings -
-Version Translation Settings tab +![Version Translation Settings tab](/images/version-translation-settings.png)
Version Translation Settings tab
diff --git a/docs/user-guide/versions/version-view.md b/docs/user-guide/versions/version-view.md index ccb118208a..089e027472 100644 --- a/docs/user-guide/versions/version-view.md +++ b/docs/user-guide/versions/version-view.md @@ -1,8 +1,6 @@ When a project version is selected, you will be shown specific details about the selected version. -
-Version View Languages Tab -
Version View
+![Version View Languages Tab](/images/version-view-languages.png)

diff --git a/mkdocs.yml b/mkdocs.yml index d0b5311498..9fd8effa2a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,9 +5,6 @@ repo_url: http://www.github.com/zanata/zanata-server theme: readthedocs # theme_dir: For custom themes -# workaround for issue: https://github.com/rtfd/readthedocs.org/issues/1260 -use_directory_urls: false - pages: - ['index.md', 'Home'] - ['release-notes.md', 'Release notes', 'Release notes']