diff --git a/docs/index.md b/docs/index.md index 962c6a2d62..83db838286 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,9 @@ Zanata Server ============= -Please visit [About|Zanata](http://zanata.org/about/) + +![Zanata](http://assets-zanata.rhcloud.com/master/assets/img/logo/logo-128.png) + +[Zanata.org](http://zanata.org) | [Twitter](http://www.twitter.com/#!/zanatatm) | [Blog](http://blog-zanatatm.rhcloud.com/) | [IRC@Freenode](http://webchat.freenode.net/?channels=zanata) Getting started ------------ @@ -28,22 +31,16 @@ Contact us Email
  • - IRC + IRC@Freenode
  • Mailing lists
    • -
  • - -
    • -
  • - Follow @zanataTM - -
    • License ------- -Zanata is Free software, licensed under the [LGPL](http://www.gnu.org/licenses/lgpl-2.1.html). \ No newline at end of file +Zanata is Free software, licensed under the [LGPL](http://www.gnu.org/licenses/lgpl-2.1.html). + +Copyright © 2015, Red Hat, Inc. \ No newline at end of file diff --git a/docs/release-notes.md b/docs/release-notes.md index c425221d28..ff6d7511c1 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -138,6 +138,7 @@ The Zanata installer's configuration now enables "connection debugging" to preve The editor prototype can be accessed via the **(Try the new alpha editor)** button at the top of the regular editor. It showcases the look and feel, workflow and intended direction of Zanata. As it is a _prototype_, there are bound to be some bugs and sub-optimal behaviours - any suggestions or reports can be forwarded to our [bug tracker](https://bugzilla.redhat.com/enter_bug.cgi?product=Zanata). + * [1150373](https://bugzilla.redhat.com/show_bug.cgi?id=1150373) - Keyboard shortcuts * [1172437](https://bugzilla.redhat.com/show_bug.cgi?id=1172437) - Add plurals to the new editor * [1174071](https://bugzilla.redhat.com/show_bug.cgi?id=1174071) - [SPA editor] Save on Invalid entry should not cause NullPointerException diff --git a/docs/user-guide/account/account-activate.md b/docs/user-guide/account/account-activate.md index 7cb76c3d6b..06e03bace4 100644 --- a/docs/user-guide/account/account-activate.md +++ b/docs/user-guide/account/account-activate.md @@ -5,7 +5,7 @@ After signing up with Zanata, you will need to activate the account before being To activate your account: 1. Check your email used for signup in Zanata. You should have received an email with subject `Zanata account activation`. - 1. If you didn't receive an email from Zanata, see [Resend activation email](user-guide/account/account-resend-activation). + 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.
    diff --git a/docs/user-guide/account/account-settings.md b/docs/user-guide/account/account-settings.md index 9ce7856d9f..0d7d9db496 100644 --- a/docs/user-guide/account/account-settings.md +++ b/docs/user-guide/account/account-settings.md @@ -45,7 +45,7 @@ This page shows all the language teams you have joined in Zanata. To join more language teams, 1. Click on `Join a language team`. - 1. See [Joining language team](user-guide/languages/language-team#joining-a-language-team). + 1. See [Joining language team](/user-guide/languages/language-team#joining-a-language-team). ## Client diff --git a/docs/user-guide/account/user-dashboard.md b/docs/user-guide/account/user-dashboard.md index e3ace86c4d..6235a9a58f 100644 --- a/docs/user-guide/account/user-dashboard.md +++ b/docs/user-guide/account/user-dashboard.md @@ -20,7 +20,7 @@ Dashboard has - translation statistics - an activity stream - list of maintained projects -- [Profile settings](user-guide/account/account-settings) +- [Profile settings](/user-guide/account/account-settings)
    ![User dashboard](/images/user-dashboard-view.png)
    diff --git a/docs/user-guide/admin/admin-overview.md b/docs/user-guide/admin/admin-overview.md index 887ebdbdd9..c49fd4fd51 100644 --- a/docs/user-guide/admin/admin-overview.md +++ b/docs/user-guide/admin/admin-overview.md @@ -16,7 +16,7 @@ To access to admin menu, login to Zanata with admin role user, select `Administr Configuration and settings for Zanata server. -See [server configuration](user-guide/admin/server-config) for more information. +See [server configuration](/user-guide/admin/server-config) for more information. ### Manage users @@ -33,11 +33,11 @@ See [server configuration](user-guide/admin/server-config) for more information. Reindexing Zanata database used for searching. -See [Manage search](user-guide/admin/manage-search) for more information. +See [Manage search](/user-guide/admin/manage-search) for more information. ### Role assignment rules -See [Role assignment rules](user-guide/admin/role-assignment-rules) for more information. +See [Role assignment rules](/user-guide/admin/role-assignment-rules) for more information. ### Translation memory @@ -47,16 +47,16 @@ See [Role assignment rules](user-guide/admin/role-assignment-rules) for more inf All background asynchronous tasks running in Zanata. -See [Process manager](user-guide/admin/process-manager) for more information. +See [Process manager](/user-guide/admin/process-manager) for more information. ### Overall statistic Overall general statistics of Zanata. -See [Statistic](user-guide/admin/statistic) for more information. +See [Statistic](/user-guide/admin/statistic) for more information. ### Server monitoring Server performance and statistics. -See [Monitoring](user-guide/admin/monitoring) for more information. \ No newline at end of file +See [Monitoring](/user-guide/admin/monitoring) for more information. \ No newline at end of file diff --git a/docs/user-guide/documents/raw-documents.md b/docs/user-guide/documents/raw-documents.md index d6b9887162..ab6f52f045 100644 --- a/docs/user-guide/documents/raw-documents.md +++ b/docs/user-guide/documents/raw-documents.md @@ -36,6 +36,6 @@ _**Workaround:** Only upload translation documents that are completely translate ## Tips for Translating 'Raw' Documents ### Inline Tags -Some parts of raw documents are not intended for direct translation. These are converted to xml-style inline tags such as "<g1><g2></g2></g1>" in the place of the image in the example document. It is recommended that these tags be included in translations with no modifications. The [XML/HTML tags validator](user-guide/projects/validations#htmlxml-tags) can help detect accidental changes to inline tags. +Some parts of raw documents are not intended for direct translation. These are converted to xml-style inline tags such as "<g1><g2></g2></g1>" in the place of the image in the example document. It is recommended that these tags be included in translations with no modifications. The [XML/HTML tags validator](/user-guide/projects/validations#htmlxml-tags) can help detect accidental changes to inline tags. -If unsure, you can also download a preview document to ensure that there are no errors or layout problems associated with treatment of tags - see [Downloading Translations through Web Interface](user-guide/documents/download-translated-documents/#from-website) \ No newline at end of file +If unsure, you can also download a preview document to ensure that there are no errors or layout problems associated with treatment of tags - see [Downloading Translations through Web Interface](/user-guide/documents/download-translated-documents/#from-website) \ No newline at end of file diff --git a/docs/user-guide/documents/upload-documents.md b/docs/user-guide/documents/upload-documents.md index b2b9c577ea..3755190471 100644 --- a/docs/user-guide/documents/upload-documents.md +++ b/docs/user-guide/documents/upload-documents.md @@ -2,7 +2,7 @@ Anyone with an account on Zanata can create a translation project for their documents. -You will need to [Create a project](user-guide/projects/create-project) and [Create a version](user-guide/versions/create-version) to upload strings. +You will need to [Create a project](/user-guide/projects/create-project) and [Create a version](/user-guide/versions/create-version) to upload strings. ------------ diff --git a/docs/user-guide/editor/documents-view.md b/docs/user-guide/editor/documents-view.md index 148052e75e..63e0904220 100644 --- a/docs/user-guide/editor/documents-view.md +++ b/docs/user-guide/editor/documents-view.md @@ -3,7 +3,7 @@ 1. **Breadcrumbs** - Links to Project -> Version 2. **Statistic** - Statistic and remaining hours for the selected project version in selected language. -3. [**Views**](user-guide/editor/overview#views-in-webtrans) +3. [**Views**](/user-guide/editor/overview#views-in-webtrans) 4. **Search** - Allow translators to by document name. 5. **Change statistic view** - Change statistic measurement in `Words`(total words in the all documents) or `Messages` (total translation entry in all documents). 6. **Settings** - From top to bottom: Notification, Chat room, Settings, Validations. @@ -38,4 +38,4 @@ **Note:** validation icons will not change until the next time validation is run on the document, even if the translations are updated. Make sure to re-run validation after making any changes so that the results are accurate. -See [validations](user-guide/projects/validations) for more details. \ No newline at end of file +See [validations](/user-guide/projects/validations) for more details. \ No newline at end of file diff --git a/docs/user-guide/editor/editor-view.md b/docs/user-guide/editor/editor-view.md index 91aeffa651..54af3c6ed4 100644 --- a/docs/user-guide/editor/editor-view.md +++ b/docs/user-guide/editor/editor-view.md @@ -3,7 +3,7 @@ ### 1. Breadcrumbs -Links to Project -> Version -> [Documents view](user-guide/editor/documents-view) -> Document name. Each link will redirect to the respective page. +Links to Project -> Version -> [Documents view](/user-guide/editor/documents-view) -> Document name. Each link will redirect to the respective page. ### 2. Statistic @@ -12,7 +12,7 @@ Statistic and remaining hours of the current document translation document. ### 3. Views -See [Views](user-guide/editor/overview#views-in-webtrans) for more information. +See [Views](/user-guide/editor/overview#views-in-webtrans) for more information. ### 4. Search and filter @@ -104,7 +104,7 @@ You will be restricted to only viewing source and translations in the editor.
    Translators can enable or disable validation check on their translations except for those which is enforced by project maintainers. -See [Project settings](user-guide/projects/project-settings#validations) for more information. +See [Project settings](/user-guide/projects/project-settings#validations) for more information. -See [validations](user-guide/projects/validations) all available check. +See [validations](/user-guide/projects/validations) all available check. \ No newline at end of file diff --git a/docs/user-guide/editor/overview.md b/docs/user-guide/editor/overview.md index e2f4dc641b..54edc48ee2 100644 --- a/docs/user-guide/editor/overview.md +++ b/docs/user-guide/editor/overview.md @@ -1,6 +1,6 @@ ## Navigating to editor -See [Translator guide](user-guide/translator-guide) for more information. +See [Translator guide](/user-guide/translator-guide) for more information. ## Views in webtrans @@ -11,7 +11,7 @@ See [Translator guide](user-guide/translator-guide) for more information. From left to right -1. [Editor view (default view)](user-guide/editor/editor-view) -2. [Documents view](user-guide/editor/documents-view) -3. [Project search and replace](user-guide/editor/project-search-replace-view) -4. [Keyboard shortcut](user-guide/editor/keyboard-shortcuts) +1. [Editor view (default view)](/user-guide/editor/editor-view) +2. [Documents view](/user-guide/editor/documents-view) +3. [Project search and replace](/user-guide/editor/project-search-replace-view) +4. [Keyboard shortcut](/user-guide/editor/keyboard-shortcuts) diff --git a/docs/user-guide/glossary/delete-glossaries.md b/docs/user-guide/glossary/delete-glossaries.md index edb10360bc..4356168538 100644 --- a/docs/user-guide/glossary/delete-glossaries.md +++ b/docs/user-guide/glossary/delete-glossaries.md @@ -1,5 +1,5 @@ ### Prerequisite -Requires **Glossary-admin** role. See [glossary roles and permission](user-guide/glossary/glossary-roles-permissions) for permission setup. +Requires **Glossary-admin** role. See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup. ### Delete via Web UI 1. Login into Zanata diff --git a/docs/user-guide/glossary/edit-glossaries.md b/docs/user-guide/glossary/edit-glossaries.md index 4d53174aa9..2891490788 100644 --- a/docs/user-guide/glossary/edit-glossaries.md +++ b/docs/user-guide/glossary/edit-glossaries.md @@ -1,8 +1,8 @@ ### Prerequisite -See [glossary roles and permission](user-guide/glossary/glossary-roles-permissions) for permission setup. +See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup. 1. Go to editor in Zanata and select a string. Instructions for opening the - translation editor can be found at [Preparing for Translation](user-guide/translator-guide#start-translate-a-project-version). + 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](/images/glossary-panel.png) diff --git a/docs/user-guide/glossary/glossary-roles-permissions.md b/docs/user-guide/glossary/glossary-roles-permissions.md index e8396f04f1..e72233105a 100644 --- a/docs/user-guide/glossary/glossary-roles-permissions.md +++ b/docs/user-guide/glossary/glossary-roles-permissions.md @@ -6,16 +6,16 @@ There are 2 roles that manage glossaries in Zanata, **glossarist** and **glossary-admin**. -User can request those roles by [contacting Zanata admin](user-guide/admin/contact-admin). +User can request those roles by [contacting Zanata admin](/user-guide/admin/contact-admin). Below are the summary of these 2 roles with their permission. - - - + + + diff --git a/docs/user-guide/glossary/upload-glossaries.md b/docs/user-guide/glossary/upload-glossaries.md index e85213f8cf..936ce3ec0e 100644 --- a/docs/user-guide/glossary/upload-glossaries.md +++ b/docs/user-guide/glossary/upload-glossaries.md @@ -1,6 +1,6 @@ ### Prerequisite -See [glossary roles and permission](user-guide/glossary/glossary-roles-permissions) for permission setup. +See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup. ### Supported file format #### PO diff --git a/docs/user-guide/groups/group-settings.md b/docs/user-guide/groups/group-settings.md index 7e9b58bc95..d398bf8bfd 100644 --- a/docs/user-guide/groups/group-settings.md +++ b/docs/user-guide/groups/group-settings.md @@ -1,5 +1,5 @@ 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. +See the [Group Creation Help](/user-guide/groups/create-group) for details on creating groups.
    ![Groups General Settings](/images/group-settings-button.png)
    Groups Settings tab link.
    @@ -8,7 +8,7 @@ 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). +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](/images/group-general-settings.png)
    Group General Settings tab
    diff --git a/docs/user-guide/project-maintainer-guide.md b/docs/user-guide/project-maintainer-guide.md index d88a7a2b39..e981f9881a 100644 --- a/docs/user-guide/project-maintainer-guide.md +++ b/docs/user-guide/project-maintainer-guide.md @@ -1,14 +1,14 @@ Any user who has joined Zanata can upload their project to be translated. -See [signup account](user-guide/account/account-sign-up) and [activate account](user-guide/account/account-activate) for more information. +See [signup account](/user-guide/account/account-sign-up) and [activate account](/user-guide/account/account-activate) for more information. ## New project -1. Create a [project](user-guide/projects/create-project) and [version](user-guide/versions/create-version). +1. Create a [project](/user-guide/projects/create-project) and [version](/user-guide/versions/create-version). 1. [Install](http://zanata-client.readthedocs.org/en/latest/installation) and [configure](http://zanata-client.readthedocs.org/en/latest/configuration) Zanata client. -1. [Upload your project documents](user-guide/documents/upload-documents). -1. [Download translated documents](user-guide/documents/download-translated-documents) when translations is completed. +1. [Upload your project documents](/user-guide/documents/upload-documents). +1. [Download translated documents](/user-guide/documents/download-translated-documents) when translations is completed. ## Migrating to Zanata -See [migrating to Zanata guide](user-guide/projects/import-projects) for migrating guide. \ No newline at end of file +See [migrating to Zanata guide](/user-guide/projects/import-projects) for migrating guide. \ 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 9fd42ff0f8..d0c1164f90 100644 --- a/docs/user-guide/projects/create-project.md +++ b/docs/user-guide/projects/create-project.md @@ -1,7 +1,7 @@ Anyone with an account can upload source strings to Zanata. The first step is to create a project: 1. **Create a project.** - 1. [Create a version](user-guide/versions/create-version) under the project. + 1. [Create a version](/user-guide/versions/create-version) under the project. 1. Upload documents to the version: - Using the website - Using the [command-line client push](http://zanata-client.readthedocs.org/en/latest/commands/push/) command @@ -39,12 +39,12 @@ A short description to provide a little more information for translators to iden Project Type defines the type of files that your project uses to store source and translation strings. This setting ensures that files for your project will be downloaded in the correct format. -There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at the [Project Types](user-guide/projects/project-types). +There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at the [Project Types](/user-guide/projects/project-types). ## Project Settings Once the project has been created, the maintainer can customize the project appearance and behaviour as required. -See the [Project Settings Help](user-guide/projects/project-settings) for details on project settings. +See the [Project Settings Help](/user-guide/projects/project-settings) for details on project settings. ## Project creation from command line diff --git a/docs/user-guide/projects/gettext-example.md b/docs/user-guide/projects/gettext-example.md index 2e5f758531..ae682a75a9 100644 --- a/docs/user-guide/projects/gettext-example.md +++ b/docs/user-guide/projects/gettext-example.md @@ -1,4 +1,4 @@ -This document presents an example of a Zanata project with type `gettext`. It assumes that you have already created a project and a version (See [Project Creation](user-guide/projects/create-project) ). +This document presents an example of a Zanata project with type `gettext`. It assumes that you have already created a project and a version (See [Project Creation](/user-guide/projects/create-project) ). Gettext projects consist of a single source file (.pot), and several translation files (.po) named after their corresponding locale. Below is a typical directory structure for a Gettext project: @@ -32,4 +32,4 @@ Notice the presence of the `zanata.xml` file already there. This file will be ge This example is also using the locale mapping feature. The `map-from` attributes on the `locale` elements are telling the client that although it will find the files using locales `es_ES` and `zh_TW`, those translated documents should be stored in the server under locales `es-ES` and `zh-Hant`. -See [Upload documents](user-guide/documents/upload-documents) and [Download translation](user-guide/documents/download-translated-documents) for more information. +See [Upload documents](/user-guide/documents/upload-documents) and [Download translation](/user-guide/documents/download-translated-documents) for more information. diff --git a/docs/user-guide/projects/import-projects.md b/docs/user-guide/projects/import-projects.md index 02f26848a3..e0aca3fa70 100644 --- a/docs/user-guide/projects/import-projects.md +++ b/docs/user-guide/projects/import-projects.md @@ -1,11 +1,11 @@ This document will provide help when importing or migrating projects into Zanata from other translation platforms. You need a user account on the Zanata instance you will migrate to. -See [signup account](user-guide/account/account-sign-up) and [activate account](user-guide/account/account-activate) for more information. +See [signup account](/user-guide/account/account-sign-up) and [activate account](/user-guide/account/account-activate) for more information. ## Create a project in Zanata -The first thing to do is to create a project and version to host your content in Zanata. You can do this using the command line clients (See [Initialising a Project](http://zanata-client.readthedocs.org/en/latest/commands/init/) ), or Zanata's web interface (See [Project Creation](user-guide/projects/create-project) ). +The first thing to do is to create a project and version to host your content in Zanata. You can do this using the command line clients (See [Initialising a Project](http://zanata-client.readthedocs.org/en/latest/commands/init/) ), or Zanata's web interface (See [Project Creation](/user-guide/projects/create-project) ). Please note that the `init` command might not be available on older platforms (like Fedora 19). Alternatively, you can use the Zanata Ivy client. For more information see [Installing the Client](http://zanata-client.readthedocs.org/en/latest/installation/) and [Configuring the Client](http://zanata-client.readthedocs.org/en/latest/configuration/). @@ -23,11 +23,11 @@ Extract the project's content from the other platform. Below are some examples o Depending on your project type, you might need to modify your Zanata configuration or your project's directory structure. Here are some examples on how to set up a project locally to be pushed to Zanata. -+ [Gettext project](user-guide/projects/gettext-example) ++ [Gettext project](/user-guide/projects/gettext-example) Gettext projects consist of a single source file (.pot), and several translation files (.po) named after their corresponding locale. -+ [Podir project](user-guide/projects/podir-example) ++ [Podir project](/user-guide/projects/podir-example) Podir projects consist of multiple source files (.pot) in a common source directory, and several translation files (.po) located in their corresponding locale's directory. diff --git a/docs/user-guide/projects/podir-example.md b/docs/user-guide/projects/podir-example.md index ab187ced18..5cf0461ea4 100644 --- a/docs/user-guide/projects/podir-example.md +++ b/docs/user-guide/projects/podir-example.md @@ -1,4 +1,4 @@ -This document presents an example of a Zanata project with type `podir`. It assumes that you have already created a project and a version (See [Project Creation](user-guide/projects/create-project) ). +This document presents an example of a Zanata project with type `podir`. It assumes that you have already created a project and a version (See [Project Creation](/user-guide/projects/create-project) ). Podir projects consist of multiple source files (.pot) in a common source directory, and several translation files (.po) located in their corresponding locale's directory. Below is a typical directory structure for a Podir project: @@ -44,5 +44,5 @@ Notice the presence of the `zanta.xml` file already there. This file will be gen -See [Upload documents](user-guide/documents/upload-documents) and [Download translation](user-guide/documents/download-translated-documents) for more information. +See [Upload documents](/user-guide/documents/upload-documents) and [Download translation](/user-guide/documents/download-translated-documents) for more information. diff --git a/docs/user-guide/projects/project-settings.md b/docs/user-guide/projects/project-settings.md index ec806c5ffe..b6ca454f48 100644 --- a/docs/user-guide/projects/project-settings.md +++ b/docs/user-guide/projects/project-settings.md @@ -1,11 +1,11 @@ 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. +See the [Project Creation Help](/user-guide/projects/create-project) for details on creating projects.
    ![Project General Settings tab](/images/project-settings-button.png)
    Project Settings tab link.
    -The Settings tab contains fields that manage appearance and workflow of your project. Some of these are already covered in the [Project Creation Help](user-guide/projects/create-project). +The Settings tab contains fields that manage appearance and workflow of your project. Some of these are already covered in the [Project Creation Help](/user-guide/projects/create-project). ------------ @@ -20,7 +20,7 @@ The Settings tab contains fields that manage appearance and workflow of your pro Project Type defines the type of files that your project uses to store source and translation strings. This setting ensures that files for your project will be downloaded in the correct format. -There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at [Project Types](user-guide/projects/project-types). +There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at [Project Types](/user-guide/projects/project-types). ### Home Page @@ -95,13 +95,13 @@ Validations not enabled here can be toggled by translators to suit their individ * Warning - display warning to translator when validation failed. Translator can save the translation as `Translated`. * Error - display error to translator when validation failed. Translator cannot save translation as `Translated` until error has been fixed. -See [validation](user-guide/projects/validations) all available check. +See [validation](/user-guide/projects/validations) all available check. ### Copy Translations settings Copy Translations attempts to reuse translations that have been entered in Zanata by matching them with untranslated strings in your project-version. These settings change the way Copy Translations behaves when a new version is created. -Refer to [the Copy Translations reference](user-guide/translation-reuse/copy-trans/) for more information. +Refer to [the Copy Translations reference](/user-guide/translation-reuse/copy-trans/) for more information. ------------ diff --git a/docs/user-guide/projects/project-view.md b/docs/user-guide/projects/project-view.md index 564add5168..f64f0ec471 100644 --- a/docs/user-guide/projects/project-view.md +++ b/docs/user-guide/projects/project-view.md @@ -15,4 +15,4 @@ The different views for a project offer more information about it. - **About** shows more information about the project. - **Settings** _(This is only available to Project Maintainers)_ allows the user to change project settings. -To [view the information about a specific version](user-guide/versions/version-view), you can click on the version's name from the list. \ No newline at end of file +To [view the information about a specific version](/user-guide/versions/version-view), you can click on the version's name from the list. \ No newline at end of file diff --git a/docs/user-guide/review/add-reviewer.md b/docs/user-guide/review/add-reviewer.md index 5f9935a60a..591b0d36ac 100644 --- a/docs/user-guide/review/add-reviewer.md +++ b/docs/user-guide/review/add-reviewer.md @@ -2,7 +2,7 @@ Translation review can only be performed for a language by users who are reviewe ## Requesting Review Privileges -You can request to be a reviewer using the [Contact Coordinators](user-guide/languages/language-team#contact-language-coordinator). +You can request to be a reviewer using the [Contact Coordinators](/user-guide/languages/language-team#contact-language-coordinator). This lets you send a message to the coordinators for the language team, in which you can write a message asking to become a reviewer. @@ -10,10 +10,10 @@ This lets you send a message to the coordinators for the language team, in which ### New team member -See [Add new member](user-guide/languages/add-team-member) for more information. +See [Add new member](/user-guide/languages/add-team-member) for more information. ### Existing team member To add reviewer role for existing user -* See [Modify role](user-guide/languages/modify-role) and check `Reviewer` on the user. \ No newline at end of file +* See [Modify role](/user-guide/languages/modify-role) and check `Reviewer` on the user. \ No newline at end of file diff --git a/docs/user-guide/review/review-enable.md b/docs/user-guide/review/review-enable.md index 273d6533bd..d3ddee2326 100644 --- a/docs/user-guide/review/review-enable.md +++ b/docs/user-guide/review/review-enable.md @@ -1,3 +1,3 @@ Translation review can be enable/disable by project maintainer in settings page. -See [Version settings|Review](user-guide/versions/version-settings#require-translation-review) for more information. \ No newline at end of file +See [Version settings|Review](/user-guide/versions/version-settings#require-translation-review) for more information. \ No newline at end of file diff --git a/docs/user-guide/review/translation-review.md b/docs/user-guide/review/translation-review.md index 421b2eab9b..daba058f45 100644 --- a/docs/user-guide/review/translation-review.md +++ b/docs/user-guide/review/translation-review.md @@ -1,7 +1,7 @@ Some project-versions require translations to be reviewed before they are considered ready to use. -Instructions for changing this setting can be found at [Enable review](user-guide/review/review-enable) +Instructions for changing this setting can be found at [Enable review](/user-guide/review/review-enable) -Review can only be performed by reviewers. To become a reviewer, see [Adding Reviewers](user-guide/review/add-reviewer) +Review can only be performed by reviewers. To become a reviewer, see [Adding Reviewers](/user-guide/review/add-reviewer) The review process is about reading translations in the 'translated' state and determining whether they are technically correct translations of sufficient quality. These instructions show how to use the user interface for accepting or rejecting translations, but does not aim to teach how to decide whether a translation should be accepted. diff --git a/docs/user-guide/system-admin/configuration/email.md b/docs/user-guide/system-admin/configuration/email.md index 296d19f33f..c50fec5b57 100644 --- a/docs/user-guide/system-admin/configuration/email.md +++ b/docs/user-guide/system-admin/configuration/email.md @@ -1,5 +1,8 @@ -As of Zanata 3.6? (https://github.com/zanata/zanata-server/pull/633) email configuration is taken directly from JBoss/WildFly's standalone.xml configuration, using the mail session configured with the JNDI name "java:jboss/mail/Default". In the default configuration of JBoss/WildFly, this expects an SMTP server on localhost port 25. +As of Zanata 3.7 (https://github.com/zanata/zanata-server/pull/633) email configuration is taken directly from JBoss/WildFly's `standalone.xml` configuration, using the mail session configured with the JNDI name `java:jboss/mail/Default`. In the default configuration of JBoss/WildFly, this expects an SMTP server on localhost port 25. -The JNDI strings starting with "java:global/zanata/smtp/" are now obsolete. If you have previously configured these values, you will need to change the configuration of the mail session "java:jboss/mail/Default" to include your preferred SMTP settings. +The JNDI strings starting with `java:global/zanata/smtp/` are now obsolete. If you have previously configured these values, you will need to change the configuration of the mail session `java:jboss/mail/Default` to include your preferred SMTP settings. -JBoss's mail session configuration is described on these pages: https://developer.jboss.org/wiki/JBossAS720EmailSessionConfigurtion-EnglishVersion and http://www.mastertheboss.com/jboss-server/jboss-configuration/jboss-mail-service-configuration +JBoss's mail session configuration is described on these pages: + +* https://developer.jboss.org/wiki/JBossAS720EmailSessionConfigurtion-EnglishVersion +* http://www.mastertheboss.com/jboss-server/jboss-configuration/jboss-mail-service-configuration diff --git a/docs/user-guide/system-admin/configuration/installation.md b/docs/user-guide/system-admin/configuration/installation.md index bd2ea23e61..71840bcc5e 100644 --- a/docs/user-guide/system-admin/configuration/installation.md +++ b/docs/user-guide/system-admin/configuration/installation.md @@ -113,10 +113,13 @@ Any other value will be treated as the name of a virus scanner command: the comm ## Running Zanata -Go to the `/bin` directory and run the `standalone.sh` (Linux, Mac) or `standalone.bat` (Windows) file. +Go to the `/bin` directory and run + +* `standalone.sh` or `start-zanata.sh` for Linux, Mac +* `standalone.bat` or `start-zanata.bat` for Windows ## Using Zanata To start using your Zanata server, open a browser and navigate to `http://localhost:8080/zanata` -You can now upload some source strings and start translating. To get started, see [Adding Source Documents](user-guide/documents/upload-documents). +You can now upload some source strings and start translating. To get started, see [Adding Source Documents](/user-guide/documents/upload-documents). diff --git a/docs/user-guide/translation-reuse/copy-version.md b/docs/user-guide/translation-reuse/copy-version.md index 9680efd806..86ffc6517e 100644 --- a/docs/user-guide/translation-reuse/copy-version.md +++ b/docs/user-guide/translation-reuse/copy-version.md @@ -2,13 +2,13 @@ Copy version is a service that allow project maintainers to create new project v This saves project maintainer from uploading the same source and translation documents every time a new version is required. -When [creating new version](user-guide/versions/create-version), project maintainer can select if it will be copying from an existing version in the same project. +When [creating new version](/user-guide/versions/create-version), project maintainer can select if it will be copying from an existing version in the same project. ## Run copy version ### From create new version page -1. [Create a new version](user-guide/versions/create-version). +1. [Create a new version](/user-guide/versions/create-version). 1. Select option `Copy from previous version`. 1. Select the version you wish to copy from. @@ -33,7 +33,7 @@ A progress bar on the version page will displays the progress of the operation. ![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. +1. This will redirect you to [Create a new version](/user-guide/versions/create-version) with pre-selected version. 1. Fill in new version id and click `Create Version` to start. A progress bar on the version page will displays the progress of the operation. \ No newline at end of file diff --git a/docs/user-guide/translator-guide.md b/docs/user-guide/translator-guide.md index af27006d65..9f5c7e9bce 100644 --- a/docs/user-guide/translator-guide.md +++ b/docs/user-guide/translator-guide.md @@ -4,7 +4,7 @@ Any translator who has joined a language team can participate in the document tr # Start translate a project version -1. Login as user. Make sure you have [joined at least 1 language team](user-guide/languages/language-team#join-a-language-team). +1. Login as user. Make sure you have [joined at least 1 language team](/user-guide/languages/language-team#join-a-language-team). 1. Click on the `Projects` menu option on the top menu. 1. Click on project you wish to translation from the list. 1. In project page, locate the version you wish to translate. @@ -16,12 +16,12 @@ Any translator who has joined a language team can participate in the document tr # Start translating a specific document in a project version -1. Login as user. Make sure you have [joined at least 1 language team](user-guide/languages/language-team#join-a-language-team). +1. Login as user. Make sure you have [joined at least 1 language team](/user-guide/languages/language-team#join-a-language-team). 1. Click on the `Projects` menu option on the top menu. 1. Click on project you wish to translation from the list. 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). +4. Click on the document name to open up the [editor](/user-guide/editor/editor-view).
    ![Select document](/images/editor-open-menu.png)
    diff --git a/docs/user-guide/versions/create-version.md b/docs/user-guide/versions/create-version.md index 6acd2086d2..cb9237e296 100644 --- a/docs/user-guide/versions/create-version.md +++ b/docs/user-guide/versions/create-version.md @@ -3,7 +3,7 @@ Documents for a project are grouped into versions, rather than being added direc For simple projects, it is typical to create a single version named 'master'. Other projects use workflows in which there is a version under active development, and one or more versions that are being maintained in a stable state with only some minor changes. Grouping these related versions under the same project allows for easier reuse of translations between versions. - 1. [Create a project](user-guide/projects/create-project). + 1. [Create a project](/user-guide/projects/create-project). 1. **Create a version under the project.** 1. Upload documents to the version: - Using the website @@ -35,12 +35,12 @@ This is the identifier used to refer to the version on the Zanata website and wh ### Project Type -Project Type defines the type of files that your project uses to store source and translation strings. For more information see the [Project Types](user-guide/projects/project-types). +Project Type defines the type of files that your project uses to store source and translation strings. For more information see the [Project Types](/user-guide/projects/project-types). ### Copy from previous version If selected, this new version is will based off the selected version. -See [Copy version](user-guide/translation-reuse/copy-version) for more information. +See [Copy version](/user-guide/translation-reuse/copy-version) for more information. ## Version creation through the command line diff --git a/docs/user-guide/versions/version-settings.md b/docs/user-guide/versions/version-settings.md index 71956093ee..a19bf777cf 100644 --- a/docs/user-guide/versions/version-settings.md +++ b/docs/user-guide/versions/version-settings.md @@ -1,5 +1,5 @@ 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. +See the [Version Creation Help](/user-guide/versions/create-version) for details on creating version.
    ![Version General Settings tab](/images/version-settings-button.png)
    Versions Settings tab link.
    @@ -16,7 +16,7 @@ See the [Version Creation Help](user-guide/versions/create-version) for details ### Project Type -Project Type settings by default inherits from project's settings but maintainers are able to select a different project type for the version. See [Project Types](user-guide/projects/project-types) and [Project Settings](user-guide/projects/project-settings/#project-type) for more information. +Project Type settings by default inherits from project's settings but maintainers are able to select a different project type for the version. See [Project Types](/user-guide/projects/project-types) and [Project Settings](/user-guide/projects/project-settings/#project-type) for more information. ### Make this version read only @@ -63,10 +63,10 @@ By default, your project will be available for translation to a set of locales d ------------ ### Require translation review -See [Review overview](user-guide/review/overview) for more information. +See [Review overview](/user-guide/review/overview) for more information. ### Customized list of validations If your version requires a different set of validations than the parent project, they can be selected here. If customized validations are not specified, the validations specified for your project will be used. An advantage of inheriting validations from the poject is that new validations can be added to the project without having to add them to each different version. -For more information, see [Project settings](user-guide/projects/project-settings#validations). +For more information, see [Project settings](/user-guide/projects/project-settings#validations). diff --git a/mkdocs.yml b/mkdocs.yml index 9fd8effa2a..403a7ebd82 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,94 +6,102 @@ theme: readthedocs # theme_dir: For custom themes pages: -- ['index.md', 'Home'] -- ['release-notes.md', 'Release notes', 'Release notes'] +- Home: 'index.md' +- Release notes: 'release-notes.md' # Getting started -- ['user-guide/translator-guide.md', 'Getting Started', 'Translator Guide'] -- ['user-guide/project-maintainer-guide.md', 'Getting Started', 'Project Maintainer Guide'] -- ['user-guide/system-admin/configuration/installation.md' , 'Getting Started', 'System admin guide'] -## Accounts -- ['user-guide/account/account-sign-up.md', 'Accounts', 'Create new account'] -- ['user-guide/account/account-activate.md', 'Accounts', 'Activate account'] -- ['user-guide/account/account-resend-activation.md', 'Accounts', 'Resend activation email'] -- ['user-guide/account/account-settings.md', 'Accounts', 'Account settings'] -- ['user-guide/account/user-profile.md', 'Accounts', 'User profile'] -- ['user-guide/account/user-dashboard.md', 'Accounts', 'User dashboard'] -## Projects -- ['user-guide/projects/project-view.md', 'Projects', 'Project view'] -- ['user-guide/projects/create-project.md', 'Projects', 'Creating a project'] -- ['user-guide/projects/project-settings.md', 'Projects', 'Project settings'] -- ['user-guide/projects/project-types.md', 'Projects', 'Project types'] -- ['user-guide/projects/validations.md', 'Projects', 'Validations'] -- ['user-guide/projects/import-projects.md', 'Projects', 'Import Projects'] -- ['user-guide/projects/gettext-example.md', 'Projects', 'Gettext Project example'] -- ['user-guide/projects/podir-example.md', 'Projects', 'Podir Project example'] -## Versions -- ['user-guide/versions/version-view.md', 'Versions', 'Version view'] -- ['user-guide/versions/create-version.md', 'Versions', 'Creating a version'] -- ['user-guide/versions/version-settings.md', 'Versions', 'Version settings'] -- ['user-guide/versions/request-to-join-group.md', 'Versions', 'Join a group'] -- ['user-guide/versions/merge-translations.md', 'Versions', 'Merge translations'] -## Documents -- ['user-guide/documents/upload-documents.md', 'Documents', 'Upload documents'] -- ['user-guide/documents/download-translated-documents.md', 'Documents', 'Download translated documents'] -- ['user-guide/documents/raw-documents.md', 'Documents', 'Raw documents'] -- ['user-guide/documents/custom-document-param.md', 'Documents', 'Custom document parameters'] -## Languages -- ['user-guide/languages/language-team.md', 'Languages', 'Language team'] -- ['user-guide/languages/add-team-member.md', 'Languages', 'Add members'] -- ['user-guide/languages/modify-role.md', 'Languages', 'Modify role'] -## Review -- ['user-guide/review/overview.md', 'Translation Review', 'Overview'] -- ['user-guide/review/review-enable.md', 'Translation Review', 'Enabling review in version'] -- ['user-guide/review/add-reviewer.md', 'Translation Review', 'Add reviewer'] -- ['user-guide/review/translation-review.md', 'Translation Review', 'Start reviewing'] -## Translation reuse -- ['user-guide/translation-reuse/copy-trans.md', 'Translation Reuse', 'Copy Trans'] -- ['user-guide/translation-reuse/copy-version.md', 'Translation Reuse', 'Copy version'] -- ['user-guide/translation-reuse/merge-trans.md', 'Translation Reuse', 'Merge translations'] -## Groups -- ['user-guide/groups/group-view.md', 'Groups', 'Group view'] -- ['user-guide/groups/create-group.md', 'Groups', 'Creating a group'] -- ['user-guide/groups/group-settings.md', 'Groups', 'Group settings'] -## Editor -- ['user-guide/editor/overview.md', 'Editor', 'Overview'] -- ['user-guide/editor/editor-view.md', 'Editor', 'Editor view'] -- ['user-guide/editor/documents-view.md', 'Editor', 'Document view'] -- ['user-guide/editor/project-search-replace-view.md', 'Editor', 'Project search replace view'] -- ['user-guide/editor/keyboard-shortcuts.md', 'Editor', 'Keyboard shortcuts'] -- ['user-guide/editor/translation-history.md', 'Editor', 'Translation history'] -## Glossary -- ['user-guide/glossary/glossary-roles-permissions.md', 'Glossary', 'Roles and Permissions'] -- ['user-guide/glossary/upload-glossaries.md', 'Glossary', 'Upload glossaries'] -- ['user-guide/glossary/edit-glossaries.md', 'Glossary', 'Edit glossaries'] -- ['user-guide/glossary/delete-glossaries.md', 'Glossary', 'Delete glossaries'] -## API -- ['user-guide/api/api.md', 'API', 'Zanata API'] -## Client -- ['user-guide/client/client.md', 'Zanata Client', 'Zanata client'] -## Drupal -- ['user-guide/drupal/drupal.md', 'Drupal plugin', 'Drupal plugin'] -## 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 +- Getting Started: + - Translator Guide: 'user-guide/translator-guide.md' + - Project Maintainer Guide: 'user-guide/project-maintainer-guide.md' + - System admin guide: 'user-guide/system-admin/configuration/installation.md' +# Accounts +- Accounts: + - Create new account: 'user-guide/account/account-sign-up.md' + - Activate account: 'user-guide/account/account-activate.md' + - Resend activation email: 'user-guide/account/account-resend-activation.md' + - Account settings: 'user-guide/account/account-settings.md' + - User profile: 'user-guide/account/user-profile.md' + - User dashboard: 'user-guide/account/user-dashboard.md' +# Projects +- Projects: + - Project view: 'user-guide/projects/project-view.md' + - Creating a project: 'user-guide/projects/create-project.md' + - Project settings: 'user-guide/projects/project-settings.md' + - Project types: 'user-guide/projects/project-types.md' + - Validations: 'user-guide/projects/validations.md' + - Import Projects: 'user-guide/projects/import-projects.md' + - Gettext Project example: 'user-guide/projects/gettext-example.md' + - Podir Project example: 'user-guide/projects/podir-example.md' +# Versions +- Versions: + - Version view: 'user-guide/versions/version-view.md' + - Creating a version: 'user-guide/versions/create-version.md' + - Version settings: 'user-guide/versions/version-settings.md' + - Join a group: 'user-guide/versions/request-to-join-group.md' + - Merge translations: 'user-guide/versions/merge-translations.md' +# Documents +- Documents: + - Upload documents: 'user-guide/documents/upload-documents.md' + - Download translated documents: 'user-guide/documents/download-translated-documents.md' + - Raw documents: 'user-guide/documents/raw-documents.md' + - Custom document parameters: 'user-guide/documents/custom-document-param.md' +# Languages +- Languages: + - Language team: 'user-guide/languages/language-team.md' + - Add members: 'user-guide/languages/add-team-member.md' + - Modify role: 'user-guide/languages/modify-role.md' +# Review +- Translation Review: + - Overview: 'user-guide/review/overview.md' + - Enabling review in version: 'user-guide/review/review-enable.md' + - Add reviewer: 'user-guide/review/add-reviewer.md' + - Start reviewing: 'user-guide/review/translation-review.md' +# Translation reuse +- Translation reuse: + - Copy Trans: 'user-guide/translation-reuse/copy-trans.md' + - Copy version: 'user-guide/translation-reuse/copy-version.md' + - Merge translations: 'user-guide/translation-reuse/merge-trans.md' + # TODO: TM Merge +# Groups +- Groups: + - Group view: 'user-guide/groups/group-view.md' + - Creating a group: 'user-guide/groups/create-group.md' + - Group settings: 'user-guide/groups/group-settings.md' +# Editor +- Editor: + - Overview: 'user-guide/editor/overview.md' + - Editor view: 'user-guide/editor/editor-view.md' + - Document view: 'user-guide/editor/documents-view.md' + - Project search replace view: 'user-guide/editor/project-search-replace-view.md' + - Keyboard shortcuts: 'user-guide/editor/keyboard-shortcuts.md' + - Translation history: 'user-guide/editor/translation-history.md' +# Glossary +- Glossary: + - Roles and Permissions: 'user-guide/glossary/glossary-roles-permissions.md' + - Upload glossaries: 'user-guide/glossary/upload-glossaries.md' + - Edit glossaries: 'user-guide/glossary/edit-glossaries.md' + - Delete glossaries: 'user-guide/glossary/delete-glossaries.md' +# API +- Zanata API: 'user-guide/api/api.md' +# Client +- Zanata client: 'user-guide/client/client.md' +# Drupal +- Drupal plugin: 'user-guide/drupal/drupal.md' +# Admin +- Admin: + - Overview: 'user-guide/admin/admin-overview.md' + - Contact Admin: 'user-guide/admin/contact-admin.md' + - Server configuration: 'user-guide/admin/server-config.md' + - Manage search: 'user-guide/admin/manage-search.md' + - Process manager: 'user-guide/admin/process-manager.md' + - Role assignment rules: 'user-guide/admin/role-assignment-rules.md' + - Statistic: 'user-guide/admin/statistic.md' + - Monitoring: 'user-guide/admin/monitoring.md' + # 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'] -- ['user-guide/system-admin/configuration/document-storage-directory.md', 'System Admin', 'Document Storage Directory'] -# Once pull request https://github.com/zanata/zanata-server/pull/633 is integrated, this can be uncommented -# - ['user-guide/system-admin/configuration/email.md', 'Configuration', 'Email'] -- ['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 © 2015, Red Hat. +- System Admin: + - Installation: 'user-guide/system-admin/configuration/installation.md' + - Authentication: 'user-guide/system-admin/configuration/authentication.md' + - Document Storage Directory: 'user-guide/system-admin/configuration/document-storage-directory.md' + - Email: 'user-guide/system-admin/configuration/email.md' + - Caches: 'user-guide/system-admin/configuration/infinispan.md' + - JMS Messaging: 'user-guide/system-admin/configuration/jms-messaging.md'
    **Roles**[Upload glossary](user-guide/glossary/upload-glossaries)[Edit glossary](user-guide/glossary/edit-glossaries)[Delete glossary](user-guide/glossary/delete-glossaries)[Upload glossary](/user-guide/glossary/upload-glossaries)[Edit glossary](/user-guide/glossary/edit-glossaries)[Delete glossary](/user-guide/glossary/delete-glossaries)