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

Commit

Permalink
Update Ivy installation doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Eng committed May 12, 2015
1 parent 57b6185 commit ce69620
Show file tree
Hide file tree
Showing 12 changed files with 59 additions and 33 deletions.
2 changes: 0 additions & 2 deletions docs/commands/init.md
@@ -1,5 +1,3 @@
# Command: init

To initialise a project from the command line, the `init` command can be used. This command will guide you through the steps necessary to set up a new or existing project, and start using Zanata.

These instructions assume that you have installed zanata-cli version 3.4.0 or higher as shown in [Installing the Client](installation).
Expand Down
2 changes: 0 additions & 2 deletions docs/commands/pull.md
@@ -1,5 +1,3 @@
# Command: pull

To download documents from your project-version, the command-line client's `pull` command can be used.

These instructions assume that you have installed zanata-cli as shown in [Installing the Client](installation), and have saved user and project configuration as shown in [Configuring the Client][configuration].
Expand Down
2 changes: 0 additions & 2 deletions docs/commands/push.md
@@ -1,5 +1,3 @@
# Command: push

To upload documents to your project-version, the command-line client's `push` command can be used.

These instructions assume that you have installed zanata-cli as shown in [Installing the Client](installation), and have saved user and project configuration as shown in [Configuring the Client][].
Expand Down
9 changes: 3 additions & 6 deletions docs/configuration.md
Expand Up @@ -36,7 +36,7 @@ To add project-version configuration to your project directory:

These steps should be repeated for each project-version before using any zanata-cli commands for the project-version.

You can customize `zanata.xml` with command hooks so that other tools will automatically run before or after Zanata commands. Read about command hooks at the [command hook page on the wiki](https://github.com/zanata/zanata-server/wiki/Client-Command-Hooks).
You can customize `zanata.xml` with command hooks so that other tools will automatically run before or after Zanata commands. Read about command hooks at the [command hook](command-hook).

## Source directory and translation directory

Expand Down Expand Up @@ -142,16 +142,13 @@ As the rule is defined as `{locale}/{path}/{filename}.po`, for locale `de-DE`,

You can also replace `{locale}` with `{locale_with_underscore}` if you want all your locales to use underscore instead of hyphen. e.g. `de-DE` will become `de_DE` which results in translation files written to or read from `{projectRoot}/de_DE/messages/kdeedu/kalzium.po`.

The mapping rules configuration is optional in zanata.xml. If not specified, standard rules are applied according to your [project type](https://github.com/zanata/zanata-server/wiki/Project-Types).
The mapping rules configuration is optional in zanata.xml. If not specified, standard rules are applied according to your [project type](http://docs.zanata.org/en/latest/user-guide/projects/project-types/index.html).

1. gettext: `{path}/{locale_with_underscore}.po`
1. podir: `{locale}/{path}/{filename}.po`
1. properties: `{path}/{filename}_{locale_with_underscore}.{extension}`
1. utf8properties: `{path}/{filename}_{locale_with_underscore}.{extension}`
1. xliff: `{path}/{filename}_{locale_with_underscore}.{extension}`
1. xml: `{path}/{filename}_{locale_with_underscore}.{extension}`
1. file: `{locale}/{path}/{filename}.{extension}`
1. file: `{locale}/{path}/{filename}.{extension}`

---

[Old instructions](https://github.com/zanata/zanata-server/wiki/Client-Configuration)
30 changes: 23 additions & 7 deletions docs/index.md
Expand Up @@ -19,16 +19,32 @@ For installation instructions please see the [Installation Section](installation
Contribute
----------

- Issue Tracker: http://bugzilla.redhat.com
- Source Code: github.com/zanata/zanata-client
- [Issue Tracker](http://bugzilla.redhat.com/buglist.cgi?product=Zanata)
- [Source Code on GitHub](http://github.com/zanata-client)

Support
Contact us
-------

If you are having issues, please let us know.
We have a mailing list located at: zanata-users@redhat.com
<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>

License
-------

The project is licensed under the [LGPL 2.1 license](https://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).
11 changes: 4 additions & 7 deletions docs/installation.md
@@ -1,5 +1,3 @@
# Installation

The Zanata client (zanata-cli) can be installed on most systems. Installation is easiest under Fedora, other systems can use Apache Ivy for installation. Manual installation is also possible.


Expand All @@ -11,13 +9,11 @@ If you are using Fedora, zanata-cli is available through the `yum` package manag
sudo yum install zanata-client
```

## Installation with Ivy

The Ivy distribution of the client is a small script that will download the client the first time it is run. This distribution requires Apache Ivy to run.
*Note:* If you are not running the latest version of Fedora, the latest version of the client may not be available, so you might want to try the Ivy version (below).

Instructions for installing Apache Ivy and the Ivy version of zanata-cli can be found at [Zanata Ivy Client on github](https://github.com/zanata/zanata-client-ivy).
## Installation with Ivy

*Note:* The Ivy client will download required files the first time it is run, which may take several minutes. It will show `resolving dependencies...` while this is happening.
See [Ivy installation](ivy/installation) for more information.

## Manual Installation

Expand All @@ -31,6 +27,7 @@ To manually install zanata-cli:

1. (optional) you can also enable tab-autocomplete for the client if you use bash as your terminal shell. This can be done by copying or linking the `zanata-cli-completion` script from the bin directory to `/etc/bash_completion.d/`. e.g. `ln -s bin/zanata-cli-completion /etc/bash_completion.d/zanata-cli-completion`.


## Nightly Builds

If you like to live dangerously, the client nightly relase is available. This may have newer features, but is not guaranteed to be stable.
Expand Down
12 changes: 12 additions & 0 deletions docs/ivy/installation.md
@@ -0,0 +1,12 @@
The Ivy distribution of the client is a small script that will download the client the first time it is run. This distribution requires Apache Ivy to run.

1. See [Setup Ivy](ivy/setup) for Apache Ivy installation.
2. Save [this script](https://raw.github.com/zanata/zanata-client-ivy/master/zanata-cli) somewhere on your path, and make sure it is executable. For example, assuming you have `~/bin in $PATH`,

```
cd ~/bin
wget https://raw.github.com/zanata/zanata-client-ivy/master/zanata-cli
chmod 755 zanata-cli
```

*Note:* It's a good idea to check for a new version of zanata-cli once in a while (especially when a new version of Zanata server is released).
14 changes: 14 additions & 0 deletions docs/ivy/setup.md
@@ -0,0 +1,14 @@
### RHEL/Fedora

For RHEL 6, you will need to enable EPEL repository, with a command like this:
`sudo rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm`

Then install Ivy (this should work on Fedora too): `sudo yum install apache-ivy`

*Note:* The Ivy client will download required files the first time it is run, which may take several minutes. It will show `resolving dependencies...` while this is happening.

### Other systems

Download an [Ivy binary distribution](http://ant.apache.org/ivy/download.cgi), extract Ivy's jar file somewhere, and set the environment variable `IVY_JAR` to point to it.

For example: `export IVY_JAR=~/apps/apache-ivy-2.3.0/ivy-2.3.0.jar`
2 changes: 0 additions & 2 deletions docs/maven-plugin/commands.md
@@ -1,5 +1,3 @@
# Commands

If your project uses Apache Maven, you can use Zanata's Maven Plugin rather than the command line client. The Maven Plugin can be used for non-Maven projects, but the same functionality is available in zanata-cli without the need to install or configure Maven.

The following instructions assume that you have installed and configured the Zanata Maven Plugin. Instructions for installation and configuration are available at [Installing the Maven Plugin](maven-plugin/installation) and [Configuring the Maven Plugin](maven-plugin/configuration)
Expand Down
2 changes: 0 additions & 2 deletions docs/maven-plugin/configuration.md
@@ -1,5 +1,3 @@
# Configuration

To use the Maven Plugin, some Zanata configuration files and an installation of Apache Maven are needed. Some additional configuration will let you use a shorter command to run the Maven Plugin.

For Apache Maven installation, see [Installing the Maven Plugin](maven-plugin/installation).
Expand Down
4 changes: 1 addition & 3 deletions docs/maven-plugin/installation.md
@@ -1,12 +1,10 @@
# Installation

If your project uses Apache Maven, you can use Zanata's Maven Plugin rather than the command line client. The Maven Plugin can be used for non-Maven projects, but the same functionality is available in zanata-cli without the need to install or configure Maven.

With Maven installed, the plugin can be run in the verbose form with no additional setup, or can be set up to use the concise form globally or for a single poject. The first time a command is run, the plugin and all its dependencies will be downloaded, which may take a while.

## Prerequisite - Install Maven

Zanata Maven plugin requires Apache Maven to be installed. Maven can be downloaded from [The Apache Maven website](http://maven.apache.org/) or installed using your operating system's package manager (e.g. `yum install maven`). Other installation options can be found at [Zanata wiki - Maven Plugin](https://github.com/zanata/zanata-server/wiki/Zanata-Maven-Integration).
Zanata Maven plugin requires Apache Maven to be installed. Maven can be downloaded from [The Apache Maven website](http://maven.apache.org/) or installed using your operating system's package manager (e.g. `yum install maven`).


## Verbose Command (No Additional Setup)
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Expand Up @@ -10,6 +10,8 @@ pages:
- ['installation.md', 'User Guide', 'Installation']
- ['configuration.md', 'User Guide', 'Configuration']
- ['command-hook.md', 'User Guide', 'Command Hook']
- ['ivy/installation.md', 'Ivy', 'Installation']
- ['ivy/setup.md', 'Ivy', 'Setup']
- ['maven-plugin/installation.md', 'Maven Plugin', 'Installation']
- ['maven-plugin/configuration.md', 'Maven Plugin', 'Configuration']
- ['maven-plugin/commands.md', 'Maven Plugin', 'Commands']
Expand Down

0 comments on commit ce69620

Please sign in to comment.