From 946ddeec0f8734c9a05b33da2066e931738ed86d Mon Sep 17 00:00:00 2001 From: Alex Eng Date: Wed, 3 Jun 2015 15:51:36 +1000 Subject: [PATCH] Remove use_directory_url: false --- docs/user-guide/account/account-activate.md | 5 +++-- .../account/account-resend-activation.md | 5 +++-- docs/user-guide/account/account-settings.md | 19 ++++++++++--------- docs/user-guide/account/account-sign-up.md | 5 +++-- docs/user-guide/account/user-dashboard.md | 15 +++++++++------ docs/user-guide/account/user-profile.md | 10 ++++++---- docs/user-guide/admin/admin-overview.md | 5 ++--- docs/user-guide/admin/contact-admin.md | 4 ++-- docs/user-guide/admin/manage-search.md | 4 +--- docs/user-guide/admin/monitoring.md | 4 +--- docs/user-guide/admin/process-manager.md | 3 +-- .../user-guide/admin/role-assignment-rules.md | 14 ++++++-------- docs/user-guide/admin/server-config.md | 12 ++++-------- docs/user-guide/admin/statistic.md | 4 +--- docs/user-guide/translator-guide.md | 5 ++--- mkdocs.yml | 3 --- 16 files changed, 54 insertions(+), 63 deletions(-) diff --git a/docs/user-guide/account/account-activate.md b/docs/user-guide/account/account-activate.md index 0e84b98271..7cb76c3d6b 100644 --- a/docs/user-guide/account/account-activate.md +++ b/docs/user-guide/account/account-activate.md @@ -8,7 +8,8 @@ To activate your account: 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. - -Account activated +
+ ![Account activated](/images/account-activated.png) +
*Note: The activation URL will expire after 24 hours.* \ No newline at end of file diff --git a/docs/user-guide/account/account-resend-activation.md b/docs/user-guide/account/account-resend-activation.md index 5feac71063..1d472e3c52 100644 --- a/docs/user-guide/account/account-resend-activation.md +++ b/docs/user-guide/account/account-resend-activation.md @@ -6,5 +6,6 @@ If you didn't receive an email after signing up, or entered wrong email address 1. You will be redirected to `account inactive` page. 1. To resend activation email to the same email address, click on `Resend activation email` button. 1. To update email address and send activation email, enter the new email address in the input field and click `Update email`. - -Resend activation or update email address \ No newline at end of file +
+ ![Resend activation or update email address](/images/account-resend-activation.png) +
\ No newline at end of file diff --git a/docs/user-guide/account/account-settings.md b/docs/user-guide/account/account-settings.md index 54aa2610ff..9ce7856d9f 100644 --- a/docs/user-guide/account/account-settings.md +++ b/docs/user-guide/account/account-settings.md @@ -1,27 +1,27 @@ -# Account Settings - To access your user settings: 1. Login to Zanata 1. Click on `User menu` on top right corner, click on `Settings` on the drop down menu. 1. Alternatively, you can click on the `Settings` tab on your dashboard page. -## Account Settings +## Settings ### Update email 1. Enter the new email address in input field and click `Update email`. - - Email input field +
+ ![Email input field](/images/account-settings-email.png) +
1. A confirmation email will be sent to the new email address. Click on the link or the URL to confirm email address change. ### Change password 1. Fill in the `Old Password` and `New Password` fields. +
+ ![Password input field](/images/account-settings-password.png) +
- Password input field - 1. Click `Update password` to change your password. ### Merge with other account @@ -38,8 +38,9 @@ Use this to merge additional Zanata accounts you may have created when signing u ## Languages This page shows all the language teams you have joined in Zanata. - -Languages +
+ ![Languages](/images/account-settings-languages.png) +
To join more language teams, diff --git a/docs/user-guide/account/account-sign-up.md b/docs/user-guide/account/account-sign-up.md index a23538085b..91ce5ff04e 100644 --- a/docs/user-guide/account/account-sign-up.md +++ b/docs/user-guide/account/account-sign-up.md @@ -16,8 +16,9 @@ To create an account using OpenID: 1. Complete the `Name`, `Username`, and `Email` fields. Ensure your email address is entered correctly. 1. Click `Save`. This sends a validation email to the address you entered in the previous step. 1. Open the validation email and click the validation link. - -Account signup openid +
+ ![Account signup openid](/images/account-signup-openid-details.png) +
You can now sign in to Zanata using your OpenID credentials. diff --git a/docs/user-guide/account/user-dashboard.md b/docs/user-guide/account/user-dashboard.md index 2dc296db56..e3ace86c4d 100644 --- a/docs/user-guide/account/user-dashboard.md +++ b/docs/user-guide/account/user-dashboard.md @@ -7,8 +7,9 @@ The dashboard aims to help you quickly see and navigate to content that is relev ## Opening the Dashboard If you sign in from the Zanata homepage, the first screen you see will be the user dashboard. To get to the dashboard from another page, expand the user menu on the right and click `Dashboard`. - -User dashboard menu +
+ ![User dashboard menu](/images/user-dashboard.png) +
## Dashboard Information @@ -20,8 +21,9 @@ Dashboard has - an activity stream - list of maintained projects - [Profile settings](user-guide/account/account-settings) - -User dashboard +
+ ![User dashboard](/images/user-dashboard-view.png) +
### User Information @@ -44,5 +46,6 @@ If you have more recent activity than is shown in the activity stream, you can s ### Projects In the Project tab, a list of your maintained projects is shown. The down arrow to the left of the version can be clicked to show all the versions for the project. The project name, version name link directly to the project page, version page respectively. - -User dashboard +
+ ![User dashboard version](/images/user-dashboard-versions.png) +
diff --git a/docs/user-guide/account/user-profile.md b/docs/user-guide/account/user-profile.md index 6d9232aa03..9cceb153d0 100644 --- a/docs/user-guide/account/user-profile.md +++ b/docs/user-guide/account/user-profile.md @@ -1,8 +1,10 @@ You can view a user's profile page by typing the username in the top search field and click on the search result. - -Project user search +
+ ![Project user search](/images/project-user-search.png) +
On the user profile page, you can view this user's recent contribution statistics according to the selected date range option. By default it will show this week's contribution categorized by language and project. - -User profile +
+ ![User profile](/images/user-profile.png) +
diff --git a/docs/user-guide/admin/admin-overview.md b/docs/user-guide/admin/admin-overview.md index d1e1536b99..887ebdbdd9 100644 --- a/docs/user-guide/admin/admin-overview.md +++ b/docs/user-guide/admin/admin-overview.md @@ -2,14 +2,13 @@ Zanata admin has full access to all functionality in Zanata. To access to admin menu, login to Zanata with admin role user, select `Administrator`.
-admin menu access +![admin menu access](/images/admin-menu-access.png)

## Admin sections -
-admin sections +![admin sections](/images/admin-sections.png)

diff --git a/docs/user-guide/admin/contact-admin.md b/docs/user-guide/admin/contact-admin.md index 3a90eb87e1..e438616117 100644 --- a/docs/user-guide/admin/contact-admin.md +++ b/docs/user-guide/admin/contact-admin.md @@ -1,11 +1,11 @@ 1. Login to Zanata. 1. At the bottom of the page, click on `Contact admin`.
-Contact admin link +![Contact admin link](/images/admin-contact-link.png)

1. In the dialog, fill in the message in the input file and click `Send`.
-Contact admin +![Contact admin](/images/admin-contact.png)

\ No newline at end of file diff --git a/docs/user-guide/admin/manage-search.md b/docs/user-guide/admin/manage-search.md index 52f9a70deb..7d0ea5e60f 100644 --- a/docs/user-guide/admin/manage-search.md +++ b/docs/user-guide/admin/manage-search.md @@ -1,6 +1,4 @@ -
-Process manager -
+![Manage search](/images/admin-manage-search.png)
Zanata uses lucene index for fast searching and perform various tasks such as translation memory search. diff --git a/docs/user-guide/admin/monitoring.md b/docs/user-guide/admin/monitoring.md index 4a7868d6eb..e452273b15 100644 --- a/docs/user-guide/admin/monitoring.md +++ b/docs/user-guide/admin/monitoring.md @@ -1,6 +1,4 @@ -
-Monitoring -
+![Monitoring](/images/admin-monitoring.png)
* Zanata uses [Java Melody](https://code.google.com/p/javamelody/) for performance and statistic monitoring. diff --git a/docs/user-guide/admin/process-manager.md b/docs/user-guide/admin/process-manager.md index f915482a36..064eb75dd7 100644 --- a/docs/user-guide/admin/process-manager.md +++ b/docs/user-guide/admin/process-manager.md @@ -1,7 +1,6 @@ All asynchronous tasks that are running in the background are shown in this page. -
-Process manager +![Process manager](/images/admin-process-manager.png)

diff --git a/docs/user-guide/admin/role-assignment-rules.md b/docs/user-guide/admin/role-assignment-rules.md index 86d5db7413..5b98d68950 100644 --- a/docs/user-guide/admin/role-assignment-rules.md +++ b/docs/user-guide/admin/role-assignment-rules.md @@ -1,16 +1,14 @@ 'Role assignment rules' are Zanata's way of dynamically assigning security roles and even Project access to users. To configure Role Assignment Rules, admin users must go to the Administration section and click 'Role assignment rules' button. -
-Role Assignment Rules Location +![Role Assignment Rules Location](/images/role-assignment-access.png)

### Overview -
-Role Assignment Rules overview +![Role Assignment Rules overview](/images/role-assignment-view.png)

@@ -33,12 +31,12 @@ To configure Role Assignment Rules, admin users must go to the Administration se 1. Navigate to 'Role assignment rules' page. 1. Click on `More Action` menu on the top right panel.
-Role Assignment Rules new +![Role Assignment Rules new](/images/role-assignment-new-access.png)

1. Select `New Rule`.
-Role Assignment Rules new form +![Role Assignment Rules new form](/images/role-assignment-new-form.png)

1. Fill in the fields and click `Save`. @@ -49,7 +47,7 @@ To configure Role Assignment Rules, admin users must go to the Administration se 1. Locate the rule you wish to delete, click on `Options` menu in front of the row. 1. Click `Delete` to remove the rule.
-Role Assignment delete +![Role Assignment delete](/images/role-assignment-delete.png)

@@ -63,7 +61,7 @@ To restrict project access, 1. Click on `Permission` tab. 1. Check `Restrict access to certain user roles` and select roles that you wish to allow access to your project.
-Role Assignment project +![Role Assignment project](/images/role-assignment-project.png)

1. Any role restrictions will now be seen on the project's page and only users belonging to that role will be able to work on the project. \ No newline at end of file diff --git a/docs/user-guide/admin/server-config.md b/docs/user-guide/admin/server-config.md index 14f5d08981..2a0c7c49f4 100644 --- a/docs/user-guide/admin/server-config.md +++ b/docs/user-guide/admin/server-config.md @@ -1,9 +1,8 @@ ## General General configuration for Zanata server. -
-Admin settings general +![Admin settings general](/images/admin-settings-general.png)

@@ -22,9 +21,8 @@ General configuration for Zanata server. ## Email log This enables or disables the sending of Zanata diagnostics log information via email. -
-Admin settings email log +![Admin settings email log](/images/admin-settings-email-log.png)

@@ -39,9 +37,8 @@ This enables or disables the sending of Zanata diagnostics log information via e ## Piwik [Piwik](http://piwik.org/) is a web analytics tools application. It tracks online visits to one or more websites and displays reports on these visits for analysis. -
-Admin settings piwik +![Admin settings piwik](/images/admin-settings-piwik.png)

@@ -53,9 +50,8 @@ This enables or disables the sending of Zanata diagnostics log information via e ## Client Admin can control the limit of client communication towards server via Client or REST API. -
-Admin settings client +![Admin settings client](/images/admin-settings-client.png)

diff --git a/docs/user-guide/admin/statistic.md b/docs/user-guide/admin/statistic.md index 604d5064a0..dc70c68b05 100644 --- a/docs/user-guide/admin/statistic.md +++ b/docs/user-guide/admin/statistic.md @@ -1,6 +1,4 @@ -
-Statistic -
+![Statistic](/images/admin-statistics.png)
This page shows the number of diff --git a/docs/user-guide/translator-guide.md b/docs/user-guide/translator-guide.md index 29b34a46cb..af27006d65 100644 --- a/docs/user-guide/translator-guide.md +++ b/docs/user-guide/translator-guide.md @@ -10,7 +10,7 @@ Any translator who has joined a language team can participate in the document tr 1. In project page, locate the version you wish to translate. 1. Click on `Options` and select `Translate in {your language}`.
-![Start translate](images/webtrans-access.png) +![Start translate](/images/webtrans-access.png)

@@ -22,8 +22,7 @@ Any translator who has joined a language team can participate in the document tr 1. In project page, click on the version you wish to translate. 3. In version page, open up the language page (default page) and select a language. 4. Click on the document name to open up the [editor](user-guide/editor/editor-view). -
-![Select document](images/editor-open-menu.png) +![Select document](/images/editor-open-menu.png)

\ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d0b5311498..9fd8effa2a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,9 +5,6 @@ repo_url: http://www.github.com/zanata/zanata-server theme: readthedocs # theme_dir: For custom themes -# workaround for issue: https://github.com/rtfd/readthedocs.org/issues/1260 -use_directory_urls: false - pages: - ['index.md', 'Home'] - ['release-notes.md', 'Release notes', 'Release notes']