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

Commit

Permalink
Merge pull request #853 from zanata/updateBrokenLink
Browse files Browse the repository at this point in the history
Fix broken internal link, update mkdocs.yml deprecated syntax
  • Loading branch information
Alex Eng committed Jun 5, 2015
2 parents 94c7743 + d1cc3cf commit 12580d1
Show file tree
Hide file tree
Showing 33 changed files with 191 additions and 179 deletions.
19 changes: 8 additions & 11 deletions 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
------------
Expand Down Expand Up @@ -28,22 +31,16 @@ Contact us
<a href="mailto:zanata-users@redhat.com" target="_top">Email</a>
</li>
<li>
<a href="http://webchat.freenode.net/?channels=zanata">IRC</a>
<a href="http://webchat.freenode.net/?channels=zanata">IRC@Freenode</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>


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).

Copyright &copy; 2015, <a href="http//www.redhat.com">Red Hat, Inc</a>.
1 change: 1 addition & 0 deletions docs/release-notes.md
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/account/account-activate.md
Expand Up @@ -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.
<figure>
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/account/account-settings.md
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/account/user-dashboard.md
Expand Up @@ -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)
<figure>
![User dashboard](/images/user-dashboard-view.png)
</figure>
Expand Down
12 changes: 6 additions & 6 deletions docs/user-guide/admin/admin-overview.md
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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.
See [Monitoring](/user-guide/admin/monitoring) for more information.
4 changes: 2 additions & 2 deletions docs/user-guide/documents/raw-documents.md
Expand Up @@ -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 "&lt;g1>&lt;g2>&lt;/g2>&lt;/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 "&lt;g1>&lt;g2>&lt;/g2>&lt;/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)
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)
2 changes: 1 addition & 1 deletion docs/user-guide/documents/upload-documents.md
Expand Up @@ -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.

------------

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/editor/documents-view.md
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
See [validations](/user-guide/projects/validations) for more details.
8 changes: 4 additions & 4 deletions docs/user-guide/editor/editor-view.md
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -104,7 +104,7 @@ You will be restricted to only viewing source and translations in the editor.
<br/>

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.

10 changes: 5 additions & 5 deletions 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
Expand All @@ -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)
2 changes: 1 addition & 1 deletion 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
Expand Down
4 changes: 2 additions & 2 deletions 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 <i class='i i--info txt--highlight'></i> icon on the glossary entry you wish to edit.
<figure>
![Glossary panel](/images/glossary-panel.png)
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/glossary/glossary-roles-permissions.md
Expand Up @@ -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.
<table>
<th>
<tr>
<td>**Roles**</td>
<td>[Upload glossary](user-guide/glossary/upload-glossaries)</td>
<td>[Edit glossary](user-guide/glossary/edit-glossaries)</td>
<td>[Delete glossary](user-guide/glossary/delete-glossaries)</td>
<td>[Upload glossary](/user-guide/glossary/upload-glossaries)</td>
<td>[Edit glossary](/user-guide/glossary/edit-glossaries)</td>
<td>[Delete glossary](/user-guide/glossary/delete-glossaries)</td>
</tr>
</th>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion 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
Expand Down
4 changes: 2 additions & 2 deletions 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.
<figure>
![Groups General Settings](/images/group-settings-button.png)
<figcaption>Groups Settings tab link.</figcaption>
Expand All @@ -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).
<figure>
![Group General Settings tab](/images/group-general-settings.png)
<figcaption>Group General Settings tab</figcaption>
Expand Down
10 changes: 5 additions & 5 deletions 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.
See [migrating to Zanata guide](/user-guide/projects/import-projects) for migrating guide.
6 changes: 3 additions & 3 deletions 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
Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions 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:

Expand Down Expand Up @@ -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.

0 comments on commit 12580d1

Please sign in to comment.