[zanata-bugs] [Bug 1204982] Documentation update for zanata.org/help + readthedocs

[bugzilla at redhat.com]

https://bugzilla.redhat.com/show_bug.cgi?id=1204982



--- Comment #3 from Alex Eng <aeng at redhat.com> ---
The outline I have in mind is 

# Welcome 
Page layout explanation
- Projects
- Groups
- Languages
- Glossary
- Dashboard

User guide
1. Registration
  1.1 register to Zanata
  1.2 activate your account
  1.3 resend activation email

2. Account settings

3. Project maintainers guide
  3.1 Creating project in Zanata

    3.1.1 project settings
    3.1.2 language settings
    3.1.3 translation settings (validation and copyTrans settings)
    3.1.3 permission and roles
    3.1.4 webhook setup

  3.2 Creating new version in Zanata
    3.2.1 Copy an existing version
    3.2.2 version settings
    3.2.3 version type
    3.2.4 language settings
    3.2.5 translation settings (validation settings)
    3.2.6 Merge translations from existing version into this.

  3.3 Uploading your project

    3.3.1 Using browser
      2.3.1.1 Uploading source documents
      2.3.1.2 Uploading translations

    3.3.2 Using Zanata-Cli
      2.3.2.1 Install/setup zanata-cli for your project
      2.3.2.2 Uploading source documents
      2.3.2.3 Uploading translations

  3.4 Downloading your project
    3.4.1 Using browser
    3.4.2 Using zanata-cli

  3.5 Joining a group (refer to group section)

  3.6 Statistics of your project translation
    {UI statistic} and {REST API statistic}

4. Translator guide 
  4.1 Joining language team (reviewer and translation role explanation)
  4.2 Translating a document (refer to features in editor for more info)
  4.3 Reviewing translations (refer to features in editor for more info)

5. Group maintainer guide
 5.1 Creating group(need admin role)
 5.2 General Settings
 5.3 Language settings
 5.4 permission and roles
 5.5 Adding project-version

6. Language coordinator guide
  6.1 permission and roles
  6.2 Requesting new language for Zanata
  6.3 Adding team member
  6.4 Removing team member
  6.4 Update team member's role

5. Features in editor
 5.1 Layout explanation
 5.2 Editor
  5.2.1 Settings (all settings of right panel)
  5.2.2 Keyboard shortcut
  5.2.3 Concurrent editing
  5.2.4 Translation memory
    5.2.4.1 TM merge
  5.2.5 Glossary
 5.3 Project-wide search and replace
  {steps for search and replace}

6. REST API documentation
  everything in
https://zanata.ci.cloudbees.com/job/zanata-api-site/site/zanata-common-api/rest-api-docs/index.html 


7. Glossary
 7.1 permission and role
 7.2 uploading glossary
 7.3 deleting glossary


8. Contacting 
  - Zanata admin
  - Language coordinator

9. TMX import/export

-- 
You are receiving this mail because:
You are on the CC list for the bug.
Unsubscribe from this bug https://bugzilla.redhat.com/token.cgi?t=ZjwBETKxds&a=cc_unsubscribe