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

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
A few incorrect URLs, and some formatting fixes.
  • Loading branch information
Carlos A. Munoz authored and carlosmunoz committed Mar 5, 2015
1 parent 979007b commit ccf09eb
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 24 deletions.
2 changes: 2 additions & 0 deletions docs/configuration/jms-messaging.md
@@ -1,3 +1,5 @@
<h1>JMS Messaging</h1>

Make sure your jboss standalone.xml has management native socket binding enabled.
You should see an entry like this:

Expand Down
1 change: 0 additions & 1 deletion docs/configuration/wildfly.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/user-guide/Opening-a-Translation-Project.md
@@ -1,2 +1,2 @@
# Instructions on opening a translation project
_TBD_

8 changes: 4 additions & 4 deletions docs/user-guide/projects/create-project.md
@@ -1,10 +1,10 @@
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]({{ site.url }}/help/projects/create-version) under the project.
1. [Create a version](user-guide/projects/create-version) under the project.
1. Upload documents to the version:
- Using the website
- Using the [command-line client push]({{ site.url }}/help/cli/cli-push) command
- Using the [command-line client push](http://zanata-client.readthedocs.org/en/latest/commands/push/) command

## Project creation through the website

Expand Down Expand Up @@ -41,12 +41,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 [Project Types wiki page](https://github.com/zanata/zanata/wiki/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 guide](user-guide/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]({{ site.url }}/help/projects/customize-project) 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/create-version.md
Expand Up @@ -7,7 +7,7 @@ For simple projects, it is typical to create a single version named 'master'. Ot
1. **Create a version under the project.**
1. Upload documents to the version:
- Using the website
- Using the [command-line client push]({{ site.url }}/help/cli/cli-push) command
- Using the [command-line client push command](http://zanata-client.readthedocs.org/en/latest/commands/push/)


## Version creation through the website
Expand Down Expand Up @@ -35,7 +35,7 @@ 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 `Project Type` under [Create a project][], and [Project Types wiki page](https://github.com/zanata/zanata/wiki/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 wiki page](user-guide/project-types).

### Require translation review

Expand Down
14 changes: 11 additions & 3 deletions 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]({{ site.url }}/help/projects/create-project) for details on creating projects.
See the [Project Creation Help](user-guide/projects/create-project) for details on creating projects.
<figure>
<img alt="Project General Settings tab" src="images/project-settings-button.png" />
<figcaption>Project Settings tab link.</figcaption>
</figure>

The Settings tab contains fields that manage appearance and workflow of your project. Some of these are already covered in the [Project Creation Help]({{ site.url }}/help/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).

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

Expand All @@ -15,12 +15,13 @@ The Settings tab contains fields that manage appearance and workflow of your pro
<img alt="Project General Settings tab" src="images/project-general-settings.png" />
<figcaption>Project General Settings tab</figcaption>
</figure>
<br>

### Project Type

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 wiki page](https://github.com/zanata/zanata/wiki/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 wiki page](user-guide/project-types).

### Home Page

Expand Down Expand Up @@ -52,11 +53,14 @@ This can be toggled using the same button, as desired.
<img alt="Project Languages Settings tab" src="/images/project-languages-settings.png" />
<figcaption>Project Languages Settings tab</figcaption>
</figure>
<br>

------------
### Reset languages from global settings

By default, your project will be available for translation to all of the enabled locales defined on the Zanata server. If your project has added or removed any languages, this button will appear, allowing you to reset the project's languages to the default list.

------------
### Add a Language

To search for available languages, enter text into the field under "Add a language". Available languages matching the entered text will display in a dropdown.
Expand All @@ -67,6 +71,7 @@ To add add a language to your project, select the desired language from the drop
<figcaption>Adding a project language</figcaption>
</figure>

------------
### Remove a Language

To remove a language from the list of available locales, first move the cursor over the language, then click the "X" that appears.
Expand All @@ -85,6 +90,7 @@ To remove a language from the list of available locales, first move the cursor o
<figcaption>Project Translation Settings tab</figcaption>
</figure>

------------
### Validations

Validations run in the translation editor and help translators to provide translations that are valid for your project. Validations set to `Warning` or `Error` in this list will be displayed in the translation editor when an invalid translation has been entered.
Expand All @@ -106,6 +112,7 @@ Refer to [the Copy Translations reference]({{ site.url }}/help/reuse/copytrans-e
<img alt="Project Permissions Settings tab" src="images/project-permissions-settings.png" />
<figcaption>Project Permissions Settings tab</figcaption>
</figure>
<br>

### Add a Maintainer

Expand All @@ -128,6 +135,7 @@ The access restriction feature is intended for use with special roles that can b
<img alt="Project About Settings tab" src="images/project-about-settings.png" />
<figcaption>Project About Settings tab</figcaption>
</figure>
<br>

About is optional rich text that will be shown on your project's about tab. This can be used to provide more detailed information to translators to help them understand and translate your project.
The rich text format is Seam Text. For help with rich text formatting, click "Seam Text" under the editor.
11 changes: 3 additions & 8 deletions docs/user-guide/projects/upload-strings.md
Expand Up @@ -2,13 +2,8 @@

Anyone with an account on Zanata can create a translation project for their strings. The basic steps are:

1. [Create a project][].
1. [Create a version][] under the project.
1. [Create a project](projects/create-project).
1. [Create a version](projects/create-version) under the project.
1. Upload documents to the version:
- Using the website
- Using the [command-line client push][] command


[Create a project]: {{ site.url }}/help/projects/create-project
[Create a version]: {{ site.url }}/help/projects/create-version
[command-line client push]: {{ site.url }}/help/cli/cli-push
- Using the [command-line client push command](http://zanata-client.readthedocs.org/en/latest/commands/push/)
12 changes: 7 additions & 5 deletions mkdocs.yml
Expand Up @@ -11,16 +11,18 @@ pages:
# Configuration Guide
- ['configuration/authentication.md', 'Configuration', 'Authentication']
- ['configuration/document-storage-directory.md', 'Configuration', 'Document Storage Directory']
- ['configuration/email.md', 'Configuration', 'Email']
# Once pull request https://github.com/zanata/zanata-server/pull/633 is integrated, this can be uncommented
# - ['configuration/email.md', 'Configuration', 'Email']
# Once pull request https://github.com/zanata/zanata-server/pull/577 is integrated, this can be uncommented
# - ['configuration/infinispan.md', 'Configuration', 'Caches']
- ['configuration/jms-messaging.md', 'Configuration', 'JMS Messaging']
- ['configuration/wildfly.md', 'Configuration', 'Wildfly']

# Release notes
- ['release-notes/release-notes-3.3.2.md', 'Release Notes', '3.3.2']
- ['release-notes/release-notes-3.4.md', 'Release Notes', '3.4']
- ['release-notes/release-notes-3.5.md', 'Release Notes', '3.5']
- ['release-notes/release-notes-3.6.md', 'Release Notes', '3.6']
- ['release-notes/release-notes-3.3.2.md', 'Release Notes', '3.3.2 - Release Notes']
- ['release-notes/release-notes-3.4.md', 'Release Notes', '3.4 - Release Notes']
- ['release-notes/release-notes-3.5.md', 'Release Notes', '3.5 - Release Notes']
- ['release-notes/release-notes-3.6.md', 'Release Notes', '3.6 - Release Notes']

# User Guide
- ['user-guide/translators-new-account.md', 'User Guide', 'Creating a new account']
Expand Down

0 comments on commit ccf09eb

Please sign in to comment.