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

Commit

Permalink
Update mkdocs.yml, fix broken link
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Eng committed Jun 12, 2015
1 parent 352a90e commit 790a04b
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 43 deletions.
6 changes: 3 additions & 3 deletions docs/commands/push.md
@@ -1,12 +1,12 @@
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][].
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].



## Source Document Upload

The basic command for uploading documents is `zanata-cli push`. The push command should always be run from the directory that contains `zanata.xml` for your project (find information about `zanata.xml` at [Configuring the Client][configuration]).
The basic command for uploading documents is `zanata-cli push`. The push command should always be run from the directory that contains `zanata.xml` for your project (find information about `zanata.xml` at [Configuring the Client][configuration.md]).

At the time of writing, you will have to specify source and translation directories with the command, even though the default push command will push only source documents to the server. This will be fixed in a future version. This means that the simplest push command is:

Expand Down Expand Up @@ -57,4 +57,4 @@ zanata-cli pull -s src -t trans --create-skeletons

The option `--create-skeletons` is used to make sure files will be written even if there are no translations.

For more information on the pull command, see [Document Download with Client](commands/pull).
For more information on the pull command, see [Document Download with Client](/commands/pull).
12 changes: 5 additions & 7 deletions docs/configuration.md
@@ -1,6 +1,4 @@
# Configuring the Client

zanata-cli requires User Configuration and Project-Version Configuration.
Zanata-cli requires User Configuration and Project-Version Configuration.

## User Configuration

Expand All @@ -13,7 +11,7 @@ To add configuration for a Zanata server:
1. Use your favourite text editor to create or open `zanata.ini` in `~/.config/`.
1. Sign into the Zanata server and navigate to the user settings page
1. Ensure that an API Key is shown. If you do not have an API Key, click 'Generate API Key' now.
![User settings page](images/302-user-settings.png)
![User settings page](/images/302-user-settings.png)

1. Copy the contents of the text-box labeled 'Configuration [zanata.ini]'.
1. Paste the copied lines into `zanata.ini` and save the file.
Expand All @@ -29,14 +27,14 @@ To add project-version configuration to your project directory:

1. Sign into the Zanata server and navigate to the appropriate version of your project.
1. Click the `Download config file` link to initiate download of `zanata.xml`.
![Download config file link on version page](images/350-version-config-file.png)
![Download config file link on version page](/images/350-version-config-file.png)

1. Save `zanata.xml` in 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](command-hook).
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.md).

## Source directory and translation directory

Expand Down Expand Up @@ -142,7 +140,7 @@ 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](http://docs.zanata.org/en/latest/user-guide/projects/project-types/index.html).
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).

1. gettext: `{path}/{locale_with_underscore}.po`
1. podir: `{locale}/{path}/{filename}.po`
Expand Down
17 changes: 8 additions & 9 deletions docs/index.md
@@ -1,3 +1,8 @@
![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)


Zanata Command line Client
=============

Expand Down Expand Up @@ -30,21 +35,15 @@ 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).

Copyright &copy; 2015, <a href="http//www.redhat.com">Red Hat, Inc</a>.
2 changes: 1 addition & 1 deletion docs/installation.md
Expand Up @@ -13,7 +13,7 @@ sudo yum install zanata-client

## Installation with Ivy

See [Ivy installation](ivy/installation) for more information.
See [Ivy installation](/ivy/installation) for more information.

## Manual Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/ivy/installation.md
@@ -1,6 +1,6 @@
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.
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`,

```
Expand Down
11 changes: 9 additions & 2 deletions docs/ivy/setup.md
@@ -1,9 +1,16 @@
### 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`
```
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.

Expand Down
6 changes: 3 additions & 3 deletions docs/maven-plugin/commands.md
@@ -1,6 +1,6 @@
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)
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)

## Basic Maven Plugin commands

Expand Down Expand Up @@ -42,7 +42,7 @@ mvn zanata:push -Dzanata.srcDir="src/messages"

This will look for source strings in "src/messages".

More detail on the push command can be found at [Document Upload with Client](commands/push)
More detail on the push command can be found at [Document Upload with Client](/commands/push)

### Pull

Expand All @@ -60,4 +60,4 @@ To download the source documents as well, specify pull type 'both' as shown here
mvn zanata:pull -Dzanata.pullType="both"
```

More detail on the pull command can be found at [Document Download with Client](commands/pull)
More detail on the pull command can be found at [Document Download with Client](/commands/pull)
2 changes: 1 addition & 1 deletion docs/maven-plugin/configuration.md
@@ -1,6 +1,6 @@
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).
For Apache Maven installation, see [Installing the Maven Plugin](/maven-plugin/installation).


## Zanata Project Configuration
Expand Down
9 changes: 7 additions & 2 deletions docs/maven-plugin/installation.md
Expand Up @@ -17,7 +17,12 @@ This is done by specifying the full plugin id including version on the command l
mvn org.zanata:zanata-maven-plugin:<PLUGIN_VERSION>:help
```

The instructions in other sections will assume that you are using the concise form of the command, so if you choose to use the verbose form you should use `mvn org.zanata:zanata-maven-plugin:<PLUGIN_VERSION>:` anywhere you see `mvn zanata:` in the instructions.
The instructions in other sections will assume that you are using the concise form of the command, so if you choose to use the verbose form you should use

```
mvn org.zanata:zanata-maven-plugin:<PLUGIN_VERSION>:
```
anywhere you see `mvn zanata:` in the instructions.

## Concise Command

Expand All @@ -27,4 +32,4 @@ Using global or per-project setup will allow the use of the concise form of the
mvn zanata:help
```

See "Global Command Configuration" under [Configuring the Maven Plugin](maven-plugin/configuration) for details.
See "Global Command Configuration" under [Configuring the Maven Plugin](/maven-plugin/configuration) for details.
30 changes: 16 additions & 14 deletions mkdocs.yml
Expand Up @@ -6,17 +6,19 @@ theme: readthedocs
# theme_dir: For custom themes

pages:
- ['index.md', 'Home']
- ['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']
- ['commands/init.md', 'Commands']
- ['commands/push.md', 'Commands']
- ['commands/pull.md', 'Commands']

copyright: Copyright &copy; 2015, <a href="http//www.redhat.com">Red Hat</a>.
- Home: 'index.md'
- User Guide:
- Installation: 'installation.md'
- Configuration: 'configuration.md'
- Command Hook: 'command-hook.md'
- Ivy:
- Installation: 'ivy/installation.md'
- Setup: 'ivy/setup.md'
- Maven Plugin:
- Installation: 'maven-plugin/installation.md'
- Configuration: 'maven-plugin/configuration.md'
- Commands: 'maven-plugin/commands.md'
- Commands:
- init: 'commands/init.md'
- push: 'commands/push.md'
- pull: 'commands/pull.md'

0 comments on commit 790a04b

Please sign in to comment.