Move documentation to readthedocs

https://bugzilla.redhat.com/show_bug.cgi?id=1204982 Squashed commit of the following: commit 97d705b Author: Alex Eng <aeng@redhat.com> Date: Tue May 5 14:08:47 2015 +1000 run png crush on png images commit 1da5a0a Author: Alex Eng <aeng@redhat.com> Date: Tue May 5 13:44:54 2015 +1000 Add Editor view details commit aab3474 Merge: e6f7391 ab66f42 Author: Alex Eng <aeng@redhat.com> Date: Tue May 5 13:13:10 2015 +1000 Merge branch 'integration/master' into rhbz1204982 commit e6f7391 Author: Alex Eng <aeng@redhat.com> Date: Tue May 5 11:09:59 2015 +1000 Convert .png to .gif commit 184ba1f Author: Damian Jansen <djansen@redhat.com> Date: Tue May 5 09:41:49 2015 +1000 Spellcheck docs commit c8e1969 Author: Alex Eng <aeng@redhat.com> Date: Tue May 5 07:21:44 2015 +1000 Add user guide commit 5cc09f3 Author: Alex Eng <aeng@redhat.com> Date: Thu Apr 30 15:51:23 2015 +1000 Migrade docs and manual from zanata.org/help commit ed33d9b Author: Alex Eng <aeng@redhat.com> Date: Tue Apr 28 16:06:35 2015 +1000 Add contact us in index page commit 5a2aac3 Merge: aeb9476 80260ce Author: Alex Eng <aeng@redhat.com> Date: Tue Apr 28 15:12:03 2015 +1000 Merge branch 'rhbz1204982' of github.com:zanata/zanata-server into rhbz1204982 commit aeb9476 Author: Alex Eng <aeng@redhat.com> Date: Tue Apr 28 15:11:49 2015 +1000 Add download translations section commit 80260ce Author: Damian Jansen <djansen@redhat.com> Date: Tue Apr 28 14:47:38 2015 +1000 Review and update some of the new documentation entries commit 926a531 Author: Alex Eng <aeng@redhat.com> Date: Tue Apr 28 14:07:43 2015 +1000 Restructure doc layout, add languages and groups section commit e9ba9cc Author: Alex Eng <aeng@redhat.com> Date: Tue Apr 28 09:15:02 2015 +1000 Add documentation for account, projects and versions commit 1318a54 Author: Alex Eng <aeng@redhat.com> Date: Mon Apr 27 15:27:14 2015 +1000 Add Account section
zanata · May 5, 2015 · 9201cfb · 9201cfb
1 parent ab66f42
commit 9201cfb
Show file tree

Hide file tree

Showing 162 changed files with 1,673 additions and 371 deletions.
diff --git a/docs/images/account-activated.png b/docs/images/account-activated.png
diff --git a/docs/images/account-resend-activation.png b/docs/images/account-resend-activation.png
diff --git a/docs/images/account-settings-email.png b/docs/images/account-settings-email.png
diff --git a/docs/images/account-settings-languages.png b/docs/images/account-settings-languages.png
diff --git a/docs/images/account-settings-password.png b/docs/images/account-settings-password.png
diff --git a/docs/images/account-signup-openid-details.png b/docs/images/account-signup-openid-details.png
diff --git a/docs/images/admin-contact-link.png b/docs/images/admin-contact-link.png
diff --git a/docs/images/admin-contact.png b/docs/images/admin-contact.png
diff --git a/docs/images/admin-menu-access.png b/docs/images/admin-menu-access.png
diff --git a/docs/images/admin-sections.png b/docs/images/admin-sections.png
diff --git a/docs/images/copy-trans-access.png b/docs/images/copy-trans-access.png
diff --git a/docs/images/copy-trans-dialog.png b/docs/images/copy-trans-dialog.png
diff --git a/docs/images/copy-trans-newversion.png b/docs/images/copy-trans-newversion.png
diff --git a/docs/images/copy-trans-permissive.png b/docs/images/copy-trans-permissive.png
diff --git a/docs/images/copy-trans-strict.png b/docs/images/copy-trans-strict.png
diff --git a/docs/images/copy-version-access.png b/docs/images/copy-version-access.png
diff --git a/docs/images/copy-version-access2.png b/docs/images/copy-version-access2.png
diff --git a/docs/images/copy-version.png b/docs/images/copy-version.png
diff --git a/docs/images/create-group-completed.png b/docs/images/create-group-completed.png
diff --git a/docs/images/create-group.png b/docs/images/create-group.png
diff --git a/docs/images/create-project-completed.png b/docs/images/create-project-completed.png
diff --git a/docs/images/create-project.png b/docs/images/create-project.png
diff --git a/docs/images/create-version-master.png b/docs/images/create-version-master.png
diff --git a/docs/images/create-version.png b/docs/images/create-version.png
diff --git a/docs/images/editor-approve-button.png b/docs/images/editor-approve-button.png
diff --git a/docs/images/editor-approved.png b/docs/images/editor-approved.png
diff --git a/docs/images/editor-doc-list-settings.png b/docs/images/editor-doc-list-settings.png
diff --git a/docs/images/editor-doc-list-validations.png b/docs/images/editor-doc-list-validations.png
diff --git a/docs/images/editor-doc-list.png b/docs/images/editor-doc-list.png
diff --git a/docs/images/editor-filter-translated.png b/docs/images/editor-filter-translated.png
diff --git a/docs/images/editor-history-button.png b/docs/images/editor-history-button.png
diff --git a/docs/images/editor-open-menu.png b/docs/images/editor-open-menu.png
diff --git a/docs/images/editor-overview.png b/docs/images/editor-overview.png
diff --git a/docs/images/editor-readonly-indicator.png b/docs/images/editor-readonly-indicator.png
diff --git a/docs/images/editor-reject-dialog.png b/docs/images/editor-reject-dialog.png
diff --git a/docs/images/editor-rejected-history.png b/docs/images/editor-rejected-history.png
diff --git a/docs/images/editor-rejected-with-comment.png b/docs/images/editor-rejected-with-comment.png
diff --git a/docs/images/editor-settings.png b/docs/images/editor-settings.png
diff --git a/docs/images/editor-translated-strings.png b/docs/images/editor-translated-strings.png
diff --git a/docs/images/editor-validations.png b/docs/images/editor-validations.png
diff --git a/docs/images/editor-views-icon.png b/docs/images/editor-views-icon.png
diff --git a/docs/images/glossary-csv.png b/docs/images/glossary-csv.png
diff --git a/docs/images/glossary-upload-windows-po.png b/docs/images/glossary-upload-windows-po.png
diff --git a/docs/images/glossary-upload-windows.png b/docs/images/glossary-upload-windows.png
diff --git a/docs/images/glossary-upload.png b/docs/images/glossary-upload.png
diff --git a/docs/images/group-general-settings.png b/docs/images/group-general-settings.png
diff --git a/docs/images/group-languages-settings.png b/docs/images/group-languages-settings.png
diff --git a/docs/images/group-maintainer-settings.png b/docs/images/group-maintainer-settings.png
diff --git a/docs/images/group-projects-remove.png b/docs/images/group-projects-remove.png
diff --git a/docs/images/group-projects-settings.png b/docs/images/group-projects-settings.png
diff --git a/docs/images/group-request-join-dialog.png b/docs/images/group-request-join-dialog.png
diff --git a/docs/images/group-request-join.png b/docs/images/group-request-join.png
diff --git a/docs/images/group-settings-button.png b/docs/images/group-settings-button.png
diff --git a/docs/images/group-view-languages.png b/docs/images/group-view-languages.png
diff --git a/docs/images/language-add-member.png b/docs/images/language-add-member.png
diff --git a/docs/images/language-contact-coordinator.png b/docs/images/language-contact-coordinator.png
diff --git a/docs/images/language-contact-menu.png b/docs/images/language-contact-menu.png
diff --git a/docs/images/language-leave-team.png b/docs/images/language-leave-team.png
diff --git a/docs/images/language-members-tab.png b/docs/images/language-members-tab.png
diff --git a/docs/images/language-request-join-menu.png b/docs/images/language-request-join-menu.png
diff --git a/docs/images/language-request-join.png b/docs/images/language-request-join.png
diff --git a/docs/images/merge-trans-access.png b/docs/images/merge-trans-access.png
diff --git a/docs/images/merge-trans-dialog.png b/docs/images/merge-trans-dialog.png
diff --git a/docs/images/project-about-settings.png b/docs/images/project-about-settings.png
diff --git a/docs/images/project-general-settings.png b/docs/images/project-general-settings.png
diff --git a/docs/images/project-languages-add.png b/docs/images/project-languages-add.png
diff --git a/docs/images/project-languages-remove.png b/docs/images/project-languages-remove.png
diff --git a/docs/images/project-languages-settings.png b/docs/images/project-languages-settings.png
diff --git a/docs/images/project-permissions-settings.png b/docs/images/project-permissions-settings.png
diff --git a/docs/images/project-settings-button.png b/docs/images/project-settings-button.png
diff --git a/docs/images/project-translation-settings.png b/docs/images/project-translation-settings.png
diff --git a/docs/images/project-user-search.png b/docs/images/project-user-search.png
diff --git a/docs/images/project-view-versions.png b/docs/images/project-view-versions.png
diff --git a/docs/images/project-webhooks-settings-2.png b/docs/images/project-webhooks-settings-2.png
diff --git a/docs/images/project-webhooks-settings.png b/docs/images/project-webhooks-settings.png
diff --git a/docs/images/upload-new-source-doc.png b/docs/images/upload-new-source-doc.png
diff --git a/docs/images/upload-source-doc-dialog.png b/docs/images/upload-source-doc-dialog.png
diff --git a/docs/images/upload-source-doc-from-settings.png b/docs/images/upload-source-doc-from-settings.png
diff --git a/docs/images/upload-source-doc.png b/docs/images/upload-source-doc.png
diff --git a/docs/images/upload-translation-doc-dialog.png b/docs/images/upload-translation-doc-dialog.png
diff --git a/docs/images/upload-translation-doc.png b/docs/images/upload-translation-doc.png
diff --git a/docs/images/user-dashboard-create-version.png b/docs/images/user-dashboard-create-version.png
diff --git a/docs/images/user-dashboard-versions.png b/docs/images/user-dashboard-versions.png
diff --git a/docs/images/user-dashboard-view.png b/docs/images/user-dashboard-view.png
diff --git a/docs/images/user-dashboard.png b/docs/images/user-dashboard.png
diff --git a/docs/images/user-profile.png b/docs/images/user-profile.png
diff --git a/docs/images/version-create-new.png b/docs/images/version-create-new.png
diff --git a/docs/images/version-create.png b/docs/images/version-create.png
diff --git a/docs/images/version-documents-settings.png b/docs/images/version-documents-settings.png
diff --git a/docs/images/version-download-translations-all-dialog.png b/docs/images/version-download-translations-all-dialog.png
diff --git a/docs/images/version-download-translations-all.png b/docs/images/version-download-translations-all.png
diff --git a/docs/images/version-download-translations.png b/docs/images/version-download-translations.png
diff --git a/docs/images/version-general-settings.png b/docs/images/version-general-settings.png
diff --git a/docs/images/version-languages-settings.png b/docs/images/version-languages-settings.png
diff --git a/docs/images/version-merge-trans-cancel.png b/docs/images/version-merge-trans-cancel.png
diff --git a/docs/images/version-merge-trans-dialog.png b/docs/images/version-merge-trans-dialog.png
diff --git a/docs/images/version-merge-trans-progress.png b/docs/images/version-merge-trans-progress.png
diff --git a/docs/images/version-more-action-menu.png b/docs/images/version-more-action-menu.png
diff --git a/docs/images/version-settings-button.png b/docs/images/version-settings-button.png
diff --git a/docs/images/version-translation-settings.png b/docs/images/version-translation-settings.png
diff --git a/docs/images/version-view-languages.png b/docs/images/version-view-languages.png
diff --git a/docs/images/webtrans-access.png b/docs/images/webtrans-access.png
diff --git a/docs/index.md b/docs/index.md
@@ -19,4 +19,32 @@ For help and support options, see [Help|Zanata](http://zanata.org/help/)
 
 License
 -------
-Zanata is Free software, licensed under the [LGPL](http://www.gnu.org/licenses/lgpl-2.1.html).
+Zanata is Free software, licensed under the [LGPL](http://www.gnu.org/licenses/lgpl-2.1.html).
+
+Release notes
+-------
+
+[Release notes](release-notes.md)
+
+Contact us
+-------
+
+<ul>
+    <li>
+        <a href="mailto:zanata-users@redhat.com" target="_top">Email</a>
+    </li>
+    <li>
+        <a href="http://webchat.freenode.net/?channels=zanata">IRC</a>
+    </li>
+    <li>
+        <a href="http://zanata.org/mailing-lists/">Mailing lists</a>
+    </li>
+    <li>
+        <iframe src="http://ghbtns.com/github-btn.html?user=zanata&repo=zanata-server&type=watch&count=true"
+            allowtransparency="true" frameborder="0" scrolling="0" width="80" height="20"></iframe>
+    </li>
+    <li>
+        <a href="https://twitter.com/zanataTM" class="twitter-follow-button" data-show-count="false">Follow @zanataTM</a>
+        <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
+    </li>
+</ul>
diff --git a/docs/user-guide/Opening-a-Translation-Project.md b/docs/user-guide/Opening-a-Translation-Project.md
diff --git a/docs/user-guide/account/account-activate.md b/docs/user-guide/account/account-activate.md
@@ -0,0 +1,14 @@
+#Activate account
+
+After signing up with Zanata, you will need to activate the account before being able to perform any tasks.
+
+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. Click the `Account activation link` in your email or copy and paste the URL provided into your browser.
+ 1. You will be redirected to Zanata with your account activated. You can now log in with your details.
+
+<img alt="Account activated" src="images/account-activated.png" />
+
+*Note: The activation URL will expire after 24 hours.*
diff --git a/docs/user-guide/account/account-resend-activation.md b/docs/user-guide/account/account-resend-activation.md
@@ -0,0 +1,10 @@
+# Resend activation email
+
+If you didn't receive an email after signing up, or entered wrong email address during signing up, you can always request to resend the account activation email or update your email address.
+
+ 1. Log in to Zanata with your username and password that you used when signing up.
+ 1. You will be redirected to `account inactive` page.
+ 1. To resend activation email to the same email address, click on `Resend activation email` button.
+ 1. To update email address and send activation email, enter the new email address in the input field and click `Update email`.
+
+<img alt="Resend activation or update email address" src="images/account-resend-activation.png" />
diff --git a/docs/user-guide/account/account-settings.md b/docs/user-guide/account/account-settings.md
@@ -0,0 +1,57 @@
+# 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
+
+### Update email
+
+ 1. Enter the new email address in input field and click `Update email`.
+
+ <img alt="Email input field" src="images/account-settings-email.png" />
+
+ 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.
+
+ <img alt="Password input field" src="images/account-settings-password.png" />
+
+ 1. Click `Update password` to change your password.
+
+### Merge with other account
+
+Use this to merge additional Zanata accounts you may have created when signing up with a connected account.
+
+ 1. Select and login into any connected account that you wish to merge with current logged in account.
+ 1. Click `Merge account` button merge from the selected connected account into current logged in account.
+
+## Profile
+
+1. To update your name, fill in updated name in input field and click `Update profile`.
+
+## Languages
+
+This page shows all the language teams you have joined in Zanata.
+
+<img alt="Languages" src="images/account-settings-languages.png" />
+
+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).
+
+## Client
+
+API key is a unique identifier used for authentication between client and Zanata server.
+Both [Zanata CLI](http://zanata-client.readthedocs.org/en/latest/installation) and [Zanata Maven plugin](http://zanata-client.readthedocs.org/en/latest/maven-plugin/installation/) uses it.
+
+ 1. To generate an API Key, click on `Generate new API Key` button.
+ 1. The updated settings for your Zanata client are available in the text area below.
+
+For more information on setting up Zanata client, see [Zanata Client configuration](http://zanata-client.readthedocs.org/en/latest/configuration/).
diff --git a/docs/user-guide/account/account-sign-up.md b/docs/user-guide/account/account-sign-up.md
@@ -0,0 +1,52 @@
+# Signing Up
+
+
+You can create an account on Zanata using an OpenID login (such as Google or Fedora), or by creating a password specific to Zanata. You can set or change your password and add OpenID accounts to your Zanata account at any time.
+
+*Note: If you want to translate a JBoss-related project, use the translate.jboss.org site, which requires a jboss.org account. You can create a jboss.org account at the [jboss.org registration page](https://community.jboss.org/register.jspa). The following instructions are for general open source projects on [translate.zanata.org](http://translate.zanata.org).*
+
+## Sign up Using OpenID
+
+To create an account using OpenID:
+
+ 1. Navigate to translate.zanata.org
+ 1. Click `Sign up` at the upper right of the page.
+ 1. Select your OpenID type or enter an OpenID URL.
+ 1. Confirm with your OpenID provider, after which you are returned to the Zanata page.
+ 1. Complete the `Name`, `Username`, and `Email` fields. Ensure your email address is entered correctly.
+ 1. Click `Save`. This sends a validation email to the address you entered in the previous step.
+ 1. Open the validation email and click the validation link.
+
+<img alt="Account signup openid" src="images/account-signup-openid-details.png" />
+
+You can now sign in to Zanata using your OpenID credentials.
+
+
+## Sign up with a New Password
+
+To use a separate password for Zanata, rather than registering with your OpenID credentials:
+
+ 1. Click `Sign up` at the upper right of the page.
+ 1. Complete the `Name`, `Email`, and other details.
+ 1. Click `Register`
+ 1. Open the validation email and click the validation link.
+
+You can now sign in to Zanata with the user name and password you entered in step 2.
+
+
+## Adding a Password
+
+If you registered with OpenID, you can still set up a password and sign in directly. To set a password, click `Change Password` under your profile settings and enter the desired password.
+
+
+## Adding OpenID Accounts to Your Zanata Account
+
+You can add OpenID accounts to your Zanata account after it is created. You can have several different accounts linked to the same Zanata account and sign in with any of them.
+
+To add an OpenID account to your Zanata account:
+
+ 1. Click the profile avatar at the upper right of the page to display the menu pane.
+ 1. Click `Settings` and then click `Manage Identities`.
+ 1. In the `Actions` menu, click `Add New Identity` and follow the procedure described earlier.
+
+*Note: if you want to translate a project that falls under the Fedora CLA, you must add a Fedora OpenID to your Zanata account. You can then sign in with your password or any OpenID account and be allowed to translate Fedora projects.*
diff --git a/docs/user-guide/account/user-dashboard.md b/docs/user-guide/account/user-dashboard.md
@@ -0,0 +1,48 @@
+The dashboard aims to help you quickly see and navigate to content that is relevant to you. With the dashboard you can:
+
+ - quickly get back to what you were doing
+ - see an overview of your projects
+ - read about recent events related to your activity on Zanata
+
+## Opening the Dashboard
+
+If you sign in from the Zanata homepage, the first screen you see will be the user dashboard. To get to the dashboard from another page, expand the user menu on the right and click `Dashboard`.
+
+<img alt="User dashboard menu" src="images/user-dashboard.png" />
+
+## Dashboard Information
+
+Dashboard has 
+
+- user information
+- joined language team
+- translation statistics
+- an activity stream 
+- list of maintained projects
+- [Profile settings](user-guide/account/account-settings)
+
+<img alt="User dashboard" src="images/user-dashboard-view.png" />
+
+### User Information
+
+At the top left, you will see your profile picture, name and username, as well as a link to user settings.
+
+### Activity Stream
+
+The activity stream is on the `Activity` tab on the left of the dashboard. It aims to show recent activity relevant to you.
+
+The activity stream shows:
+
+ - Translations you have done. This includes links to the project, version, language and document that was translated. There is also a link to the last translation of a batch, so you can easily pick up translating where you left off the previous day or before a break.
+ - Reviews you have done. This will include similar information to translations.
+ - Documents you have uploaded recently. This includes links to the project, version and document.
+
+The icon to the right of each item shows the type of activity - document uploads have a document icon, translations have a globe icon and reviews have an eye icon.
+
+If you have more recent activity than is shown in the activity stream, you can see more by clicking `more activity` at the bottom of the stream.
+
+### Projects
+
+In the Project tab, a list of your maintained projects is shown. The down arrow to the left of the version can be clicked to show all the versions for the project. The project name, version name link directly to the project page, version page respectively.
+
+<img alt="User dashboard" src="images/user-dashboard-versions.png" />
diff --git a/docs/user-guide/user-profile.md → docs/user-guide/account/user-profile.md b/docs/user-guide/user-profile.md → docs/user-guide/account/user-profile.md
@@ -1,6 +1,8 @@
-# User Profile Page
-
 You can view a user's profile page by typing the username in the top search field and click on the search result.
 
+<img alt="Project user search" src="images/project-user-search.png" />
+
 On the user profile page, you can view this user's recent contribution statistics according to the selected date range option.
 By default it will show this week's contribution categorized by language and project.
+
+<img alt="User profile" src="images/user-profile.png" />
diff --git a/docs/user-guide/admin/admin-overview.md b/docs/user-guide/admin/admin-overview.md
@@ -0,0 +1,55 @@
+Zanata admin has full access to all functionality in Zanata.
+
+To access to admin menu, login to Zanata with admin role user, select `Administrator`.
+<figure>
+<img alt="admin menu access" src="images/admin-menu-access.png" />
+</figure>
+<br/>
+
+## Admin sections
+
+<figure>
+<img alt="admin sections" src="images/admin-sections.png" />
+</figure>
+<br/>
+
+## Server configuration
+
+Configuration and settings for Zanata server.
+
+## Manage users
+
+- Edit user information such as password, roles.
+- Delete users in Zanata.
+
+
+## Manage Roles
+
+- Create new roles to Zanata.
+- Edit/Remove roles in Zanata.
+
+## Manage Search
+
+- Reindexing Zanata database used for searching.
+
+## Role assignment rules
+
+Role Assignment Rules assist with the automatic assignment of user roles to certain users when they sign in. If the user's identity (e.g. user name) matches a certain pattern and they are authenticated in a certain way (e.g. via Open Id where available), Zanata will be able to automatically add the user to a specified user Role.
+
+## Translation memory
+
+- Import/Export external TMX file for translation memory in editor.
+
+## Process manager
+
+- See all background asynchronous tasks running in Zanata.
+
+## Overall statistic
+
+Overall general statistics of Zanata.
+
+- Number of users, projects, documents and translations.
+
+## Server monitoring
+
+- Server performance and statistics.
diff --git a/docs/user-guide/admin/contact-admin.md b/docs/user-guide/admin/contact-admin.md
@@ -0,0 +1,11 @@
+1. Login to Zanata.
+1. At the bottom of the page, click on `Contact admin`.
+<figure>
+<img alt="Contact admin link" src="images/admin-contact-link.png" />
+</figure>
+<br/>
+1. In the dialog, fill in the message in the input file and click `Send`.
+<figure>
+<img alt="Contact admin" src="images/admin-contact.png" />
+</figure>
+<br/>
diff --git a/docs/user-guide/api/api.md b/docs/user-guide/api/api.md
@@ -0,0 +1 @@
+All Zanata API documentation is located at [Zanata API](https://zanata.ci.cloudbees.com/job/zanata-api-site/site/zanata-common-api/rest-api-docs/index.html)
diff --git a/docs/user-guide/client-command-hook.md b/docs/user-guide/client-command-hook.md