Update Docs 0.8.7

docs/source/getinvolved.rst

@@ -69,8 +69,8 @@ Hack and Develop
 - Generate docs :code:`make docs`
 
 
-Contribution
-------------
+Contribute
+----------
 
 * The *devel* branch is the release actively under development.
 * The *master* branch corresponds to the latest stable release.

docs/source/index.rst

@@ -15,7 +15,13 @@ In a software release cycle, some of the necessary localization steps lack atten
 
 Transtats Server is a simple django application with PostgreSQL backend, which analyses and processes the translation data for meaningful representations. It has a CLI and some ansible playbooks for deployments. And, can be deployed on shared, dedicated or container based environments.
 
-The ``Jobs framework`` is a centralized processor through which we can solve multiple sets of problems in a flexible way. Because, it has information about Product Release (*and its Schedule*), Package Source Repo, Package Translation Platform, and Package Build System; and interestingly we can expand the support. Multiple sets of problems can be captured and executed in the form of Job Templates. Moreover, as the jobs are YAML based, they're flexible.
+The ``Jobs framework`` is a centralized processor through which we can solve multiple sets of problems in a flexible way. Because, it has information about Product Release (*and its Schedule*), Package Source Repo, Package Translation Platform and Package Build System. Multiple sets of problems can be captured and executed in the form of Job Templates. Moreover, as the jobs are YAML based, they're flexible.
+
+Transtats can..
+ - Tell us how we're doing on delivering translations for product releases.
+    - From a language and a package perspective.
+ - Transport translations from one place to another.
+ - Help spot differences: source repository vs translation platform vs build system.
 
 
 Help
@@ -29,6 +35,7 @@ Join **#transtats** channel at Libera.Chat, write to transtats@redhat.com
     :maxdepth: 2
 
     overview
+    server
     api
     client
     getinvolved

docs/source/overview.rst

@@ -30,9 +30,9 @@ Workflow Automation
 -------------------
 
 1. Job templates
-    Currently, six templates are to choose from. They can be used as-is.
+    Currently, seven templates are to choose from. They can be used as-is.
 
-    ``syncupstream``, ``syncdownstream``, ``stringchange``, ``pushtrans``, ``dpushtrans`` and ``pulltrans``
+    ``syncupstream``, ``syncdownstream``, ``stringchange``, ``pushtrans``, ``dpushtrans``, ``pulltrans`` and ``pulltransmerge``
 
     - `syncupstream`
         clone package source repository, filter translation files and calculate statistics
@@ -46,6 +46,8 @@ Workflow Automation
         download translations from package translation platform and upload to the CI platform.
     - `pulltrans`
          download translations from CI platform and submit back.
+    - `pulltransmerge`
+         download translations from CI platform and creates merge request.
 
 
     Requires four values:
@@ -56,7 +58,7 @@ Workflow Automation
      - Pipeline UUID (*gets generated as soon as a pipeline is created*)
 
     **SyncDownstream**
-    could be run for any package (also for those not added in transtats) and for any build tag available. This makes the job really wonderful tool to inspect SRPM.
+    could be run for any package (also for those not added in Transtats) and for any build tag available. This makes the job really wonderful tool to inspect SRPM.
 
     Dry runs are also supported. Each YAML job has a unique URL to see details and share!
 

docs/source/server.rst

@@ -0,0 +1,85 @@
+================
+Transtats Server
+================
+
+`transtats <https://github.com/transtats/transtats>`_ is a django application with postgres backend.
+
+Releases
+--------
+
+Transtats can have one or multiple product(s) in one instance. And each Product can have multiple releases.
+Staff role can manage products and releases. Adding a release has following fields:
+
+``Release Branch Name`` Product release name with version. for example: Fedora 37
+
+``Release Slug`` Transtats will formulate slug.
+*And this slug will be validated with iCal retrieved from URL.* for example: fedora-37
+
+``Current Phase`` Phase in which this release is running. for example: Development
+
+``Language Set`` Language set which should be associated with this release.
+*This is useful when we need to track a release for custom set of languages.*
+
+``iCal URL`` Release schedule calendar URL. To fetch release milestone and dates.
+
+``SCM Branch`` (optional) Release Build System Default Tag. for example: f37
+
+``Enable flags`` Track Translation will enable translation tracking for this release.
+
+
+Languages
+---------
+
+Languages are the backbone of translations tracking and other operations. Adding a language has following fields:
+
+``Language Name`` Name of the language. for example: Japanese
+
+``Locale ID`` Locale in the form of LANG_TERRITORY. for example: ja_JP
+
+``Locale Script`` Script the language is based upon. for example: Hani
+
+``Locale Alias`` (optional) for example: zh-Hans can be an alias for zh_CN locale.
+
+
+Platforms
+---------
+
+In Transtats, Platform refers to a translation platform. for example Damned Lies, Phrase, Transifex, Weblate, Zanata, etc.
+Adding a Platform has following fields:
+
+``Platform Engine`` (dropdown) Platform engine helps system to determine specific tasks. for example: WEBLATE
+
+``Platform Subject`` for example: Fedora
+
+``Server URL`` for example: https://translate.fedoraproject.org
+
+``Platform SLUG`` (dropdown) for example: WLTEFED refers to Weblate Fedora instance
+
+``Enable/Disable`` To enable platform for sync operations.
+
+``Server URL`` for example: https://translate.fedoraproject.org
+
+``Auth User`` Username for API auth purposes.
+
+``Auth Password/Token`` Password or Token for API auth purposes.
+
+``CI Enable/Disable`` To enable platform for CI Pipeline operations.
+
+
+Packages
+--------
+
+An authenticated user can create and manage a package. (a project in Transtats)
+Adding a Package has following fields:
+
+``Package Name`` Package id as-in translation platform. *Existence is validated with the translation platform.*
+
+``Upstream URL`` Source repository location (Bitbucket, GitHub, Pagure etc).
+
+``Upstream Localization URL`` (optional) Source repository location with translation resources.
+
+``Translation Format`` (radio) File format translations are stored in the project.
+
+``Translation Platform`` (dropdown) Translation statistics will be fetched from this server.
+
+``Products`` (check) Translation progress for selected products will be tracked.