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

Commit

Permalink
Add a project and version view sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosmunoz committed Mar 15, 2015
1 parent 541fc6c commit add0584
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/configuration/authentication.md
Expand Up @@ -206,7 +206,6 @@ standalone.xml:

### Single Provider

_( As of version 3.5.1 )_
It's possible to configure Zanata to use a single pre-defined Open Id authentication provider. To do this, just add an extra `module-option` to the `login-module` element, like this:

```xml
Expand Down
Binary file added docs/images/project-view-versions.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/version-view-languages.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/user-guide/projects/project-view.md
@@ -0,0 +1,19 @@
When a project is selected, you will be taken to an overall view of the project. This will show a list of the available versions as well as an indication of their translation progress.

<figure>
<img alt="Project Languages Settings tab" src="/images/project-view-versions.png" />
<figcaption>Project View</figcaption>
</figure>
<br>

1. Project Information
2. Switches between the different views available for the project
3. Different options to sort project versions.

The different views for a project offer more information about it.

- **Maintainers** shows the project Maintainers.
- **About** shows more information about the project.
- **Settings** _(This is only available to Project Maintainers)_ allows the user to change project settings.

To [view the information about a specific version](user-guide/versions/version-view), you can click on the version's name from the list.
18 changes: 18 additions & 0 deletions docs/user-guide/versions/version-view.md
@@ -0,0 +1,18 @@
When a project version is selected, you will be shown specific details about the selected version.

<figure>
<img alt="Version View Languages Tab" src="/images/version-view-languages.png" />
<figcaption>Version View</figcaption>
</figure>
<br>

1. Project and version information
2. Version's overall translation progress information.
3. A list of languages that are available for translation on the version.
4. Once a language is selected, a list of documents for the version will be shown, with progress information for each document and the selected language.

The different tabs for a version offer more information about it.

- **Documents** Similar to the languages tab, this view lest you select a single document to view detailed progress information for each language.
- **Groups** Shows if there are any groups that the version belongs to.
- **Settings** _(This is only available to Project Maintainers)_ allows the user to change version settings.
3 changes: 3 additions & 0 deletions mkdocs.yml
Expand Up @@ -31,5 +31,8 @@ pages:
- ['user-guide/projects/project-settings.md', 'User Guide', 'Project settings']
- ['user-guide/projects/create-version.md', 'User Guide', 'Creating a Version']
- ['user-guide/projects/upload-strings.md', 'User Guide', 'Upload Strings']
- ['user-guide/projects/project-view.md', 'User Guide', 'The Project view']
## Version
- ['user-guide/versions/version-view.md', 'User Guide', 'The Version view']

copyright: Copyright &copy; 2015, <a href="http//www.redhat.com">Red Hat</a>.

0 comments on commit add0584

Please sign in to comment.