From ebe9e20cf65720d70efac702f4b4f3d905517f80 Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Thu, 1 Feb 2024 10:48:33 +0100 Subject: [PATCH] Publish docs on GitHub pages (#34) * Remove old documentation and update existing one to properly reflect. * Remove leftover translation files * Deploy documentation on Github pages * Adding a warning to the user/reader --- .github/workflows/deploy-gh-pages.yaml | 55 ++ .gitignore | 4 + Documentation/about.md | 176 ------ docs/source/about/meters.rst | 16 - docs/source/about/targets.rst | 2 +- docs/source/about/targets_sidebar.rst | 18 + docs/source/index.rst | 5 + docs/source/locales/fr/LC_MESSAGES/about.po | 519 ------------------ docs/source/locales/fr/LC_MESSAGES/index.po | 31 -- .../locales/fr/LC_MESSAGES/installation.po | 364 ------------ 10 files changed, 83 insertions(+), 1107 deletions(-) create mode 100644 .github/workflows/deploy-gh-pages.yaml delete mode 100644 Documentation/about.md create mode 100644 docs/source/about/targets_sidebar.rst delete mode 100644 docs/source/locales/fr/LC_MESSAGES/about.po delete mode 100644 docs/source/locales/fr/LC_MESSAGES/index.po delete mode 100644 docs/source/locales/fr/LC_MESSAGES/installation.po diff --git a/.github/workflows/deploy-gh-pages.yaml b/.github/workflows/deploy-gh-pages.yaml new file mode 100644 index 000000000..3ca97d80a --- /dev/null +++ b/.github/workflows/deploy-gh-pages.yaml @@ -0,0 +1,55 @@ +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy GitHub Pages with Sphinx-docs + +on: + # Runs on pushes targeting the default branch + push: + branches: [main] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: pages + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Pages + uses: actions/configure-pages@v2 + - name: Install Sphinx and plugins + run: | + pipx install sphinx + pipx inject sphinx recommonmark + pipx inject sphinx sphinx_rtd_theme + - name: Build docs with Sphinx-docs + working-directory: docs + run: make html + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: docs/build/ + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/.gitignore b/.gitignore index 770de1582..cdc0bac58 100644 --- a/.gitignore +++ b/.gitignore @@ -60,3 +60,7 @@ docker-compose-prod-non-domain.yml docker-compose-prod.yml install-production.sh .gitlab-ci.yml + +# Sphinx documentation +docs/_build/ +docs/build/ diff --git a/Documentation/about.md b/Documentation/about.md deleted file mode 100644 index e22bf5108..000000000 --- a/Documentation/about.md +++ /dev/null @@ -1,176 +0,0 @@ -# Micro Power Manager - -## Terms - -- **Mini-Grid:** It is an off-grid electricity distribution network that includes small/medium-scale electricity generation. - -- **Cluster:** The area that covers the grouped Mini-Grids. - -- **Customer:** It defines individual clients and businesses registered in MPManager. - -- **Meter:** A pre-paid energy meter that works with an STS-Token. - -- **Transaction:** Incoming payments from customers. - -- **Ticket:** It is the place where customer problems, complaints, and demands are collected. - -- **Tarriff:** The combination of energy(kWh) price and the fixed price(access rate). - -- **Target:** It is a goal for a Mini-Grid/ Cluster that the company wants to reach at a given time. - -- **Asset Type:** An object, that could be sold to locals to help/improve their productivity or live quality. - -- **Maintenance:** This is the place where external contractors are assigned to predefined jobs like "connect a new house-hold to the grid", "replacing not working meters, etc.". - -## Before using MPManager - -The key component(s) of the system is a mixture of meter/customer. That means both melts into each other a bit. The only way to register a customer or a meter is to register them both at the same time. For that reason from now on, every registered person will be mentioned as a **customer**. - -### Register a customer & meter - -There is an additional [Android Application](https://github.com/inensus/Customer-Meter-Registration) that should be used to register a customer with a meter together. The application allows you to select the village where the customer lives, the meter manufacturer, and the energy tariff that should be assigned to the meter. - -### Tariffs - -Its basically the energy price per kWh with an optional access rate/subscription fee. The operator is free to define the period of that fee. Ex: Every 7 days. - -### Payment Channels - -or now, the system supports only incoming payments from Airtel Tanzania and Vodacom Tanzania. Both providers are accepting Mobile Money and notify the MPManager over a secure tunnel. - -### Payments - -Each incoming payment has to contain the meter number. That is the unique number that is used to identify the other channels where the money could spend. After payment is been received the system automatically checks these further points; - - 1. Missing Asset Type Rates - 2. Not paid Access Rates - 3. Convert the money to energy and generate an STS-Token for the calculated energy amount. At the end of the payment process, the customer will be notified about each step. - - At the end of the payment process the customer will be notified about each step. - -If the entered meter number is not valid the system refuses the payment automatically. - -### Selling an Asset - -The system supports to sell assets to customers on a rate basis plan. A water pump or a milling machine will be a good example of that. - -## Targets - -A target can be assigned to a whole cluster or for a single Mini-Grid. The important thing by assigning a target is; - -If the target is assigned to a cluster, the manager will see only that target on the cluster dashboard. However, if a single Mini-Grid or all Mini-Grids in a cluster has a defined target. The manager will see the calculated sum of these targets. - -Example: Cluster 1 has following Mini-Grids; MG-1 MG-2 and MG-3 - -|#| MG-1 | MG-2| MG-3| -|---|---|---|---| -|New Connections | 100 | 200 | 500 | - -The result of the cluster overview page would be 800 for expected new connections. - -## MPManager - -**Note: The pages that contain only a `List of X` and a `Add new X` button without any other key feature are not explained below.** - -### Clusters Dashboard - -It is basically the whole overview of the business. It shows some quick information like total revenue, registered meters and the number of registered clusters. - -There are also more sections; - -1. **Financial overview:** That breaks the total revenue to Mini-Grid level. The manager can see/analyse each Mini-Grid with that. -2. **Cluster Map:** The maps shows graphically where the clusters are located. The clusters on the map are clickable and forwards the manager to the next level dashboard **Cluster Dashboard** - -To register a new cluster find the red plus button on the right bottom corner of the screen. - -## Cluster Dashboard - -The cluster dashboard is built similar to the clusters dashboard. There are small informative boxes at the top of the screen. -The financial overview and the map are based on Mini-Grids instead of clusters. - -There are two new sections available; - -1. Revenue Analysis: That is the place where all targets of MiniGrids are shown together. -2. Revenue Trends: That is a chart that breaks down the revenue to customer groups. - -## Mini-Grid Dashboard - -Mini-grids are the building blocks of clusters. This dashboard provides information about the selected Mini-Grid, such as **revenue per customer**, **targeted revenue per customer type**, **energy sold**, **actual payment** ,and **the daily weather forecast** is the area where it can observe and analyze the income distribution of the selected Mini-Grid. - -Also on this page, the status of **tickets** created by customers in the related Mini-Grid can be observed. - -## Customers - -MPManager customers are listed under `Customers` in the sidebar. This table contains the customers' name, phone number, city, and meter number. The search function also includes all those fields. - -By clicking on a customer, will load the details of that specific customer. - - This `customer details` page shows all information about that customer. - - Such as - -- Basic Details: Name, Surname, Birth Date, etc. -- Payment flow: Is a chart that shows how often the customer makes payments -- Addresses: A list of the addresses that belong to the customer. -- Sold Assets: The assets, that bought by the customer. -- A detailed list of the payments. -- Payment types: Shows how the sent money is neem spent (Energy, Access Rate payment, etc.). -- List of tickets that belong to the customer. -- A list of the meters which belong to the customer and a map where the meters are visually displayed. - -Some of the elments are editable (ex:name,surname) or addable (ex:ticket, address). - -## Meters - -The `Meters` link on the sidebar loads a list that contains all registered meters with some additional details such as its serial number, assigned tariff, etc.. The search area on the page searches in `serial_number` and `tariff name`. - -By clicking on a meter in the list, a new `meter detail` page will be loaded. This page, contains `basic information`, `meter details`, and `meter transactions`. If the meter can send its usage data it also shows it in an additional `meter reading` section. The `Basic Information` section contains the total revenue that the meter made, the owner, when the last payment occurs, and the registration date. `Meter Details` are meter specified details such as the manufacturer name, the serial number, assigned tariff, and its connection type. `Meter transactions` is a basic list that contains all transactions that hit the meter. - -## Targets (Sidebar) - - By clicking on `Targets` in the sidebar will load a page with already set targets. The list shows only the key fields of each target. To see the details of a target, click on the `Expand` button. - -To add a **new Target** just click on the `New Target` on the right top side. After clicking on that button, a new page will be loaded. Firstly the manager/admin should assign a Cluster or a Mini-Grid. -Then, the date until that target is valid should be selected. - -When these two steps are done; Its time to define our target with some fields like `New connections`, `Revenue per Month`,... None of these fields are marked as required. That means the manager/admin is free to enter or not to enter a value for each goal. - -## Transactions - -The page contains two main sections. - -1. The comparison section; gives a quick overview of the situation. That section contains; Total incoming transactions, Confirmed Transactions, Cancelled Transactions, and the Revenue. The part which makes that information a bit interesting is the availability of comparison. The manager/admin can compare the day with; yesterday, same day last week, or the current week with last week or the current month with last month. - -2. A basic list with incoming transactions. The list has an advanced filtering option instead of a basic search as in other pages. - -By clicking on a Transaction, the `Transaction detail` page will load. The detail page contains the `Mobile Provider-specific data`, `Basic Data`, `Sent Sms`, and `Transaction Processing`. - -**Mobile Money Provider-specific data:** The name of the provider and the transaction details. This information is required by the mobile money provider in case of an issue. - -**Transaction Processing:** A detailed list that shows how the incoming money is been used by the system. Ex: 100$ for Energy, 20$ for Access Rate, and 400$ for Milling Machine Rate Payment. - -## Tickets - -MPManager is using [Trello](https://trello.com) as a ticketing platform. All tickets are basically Trello cards. The database is only holding references to the tickets. The ticketing system aims to resolve requests and complaints from customers as quickly as possible. It is important to assign a ticket to the correct category to maintain tickets easily. Therefore, there are some ticket categories. To add/ list category please click on `Categories` that is listed under `Tickets` in the sidebar. - -### Adding User to Ticketing System - -As already mentioned, the ticketing system is using Trello. To be able to assign tickets internally, all the staff has to be registered on [Trello](https://trello.com). The user name is been used to associate the Trello user to MPManager users. - -To add a user click on `Users` in the list below `Tickets`. It will ask you the `Ticketing System Tag`. That is the name that begins with an **@** in the Trello user profile. - -## Maintenance - -In some cases, it is wiser to use external resources to solve small problems. Maintenance is exactly for that there. The maintenance users are some experts who are not working for the company but works per contract. - -There is a form to create a **New Maintenance Request**. That page asks the manager/admin about the job todo, the deadline for the task, the person who is responsible to do that, and the price for the task. The created task will be sent out to the external person via SMS. The created maintenance job/task is also saved as a ticket. The gain by saving that task as a ticket is, in case of a problem the person who is assigned to that job can reply to the initial SMS. The incoming SMS will automatically add to the ticket as a response. - -## Sms - -Sms is the key communication infrastructure. It is used by `Transactions` and `Maintenance`. But what if the company wants to send some inform their customers about something like an unplanned electricity cut. That is the reason why `Sms`is listed in the sidebar as an extra service. - -The manager/admin can send SMS's to a specific Mini-Grid, to a specific customer group/type or single customers. - -## Reports - -MPManager has a reports page where managers can download reports. This page contains weekly, monthly, and payment requests. diff --git a/docs/source/about/meters.rst b/docs/source/about/meters.rst index 5d310dd8b..a7747f342 100644 --- a/docs/source/about/meters.rst +++ b/docs/source/about/meters.rst @@ -16,19 +16,3 @@ date. ``Meter Details`` are meter specified details such as the manufacturer name, the serial number, assigned tariff, and its connection type. ``Meter transactions`` is a basic list that contains all transactions that hit the meter. - -## Targets By clicking on ``Targets`` in the sidebar will load a page -with already set targets. The list shows only the key fields of each -target. To see the details of a target, click on the ``Expand`` button. - -To add a **new Target** just click on the ``New Target`` on the right -top side. After clicking on that button, a new page will be loaded. -Firstly the manager/admin should assign a Cluster or a Mini-Grid (The -difference is already explained -`here <#Information-before-using-MPManager>`__). Then, the date until -that target is valid should be selected. - -When these two steps are done; Its time to define our target with some -fields like ``New connections``, ``Revenue per Month``,... None of these -fields are marked as required. That means the manager/admin is free to -enter or not to enter a value for each goal. diff --git a/docs/source/about/targets.rst b/docs/source/about/targets.rst index 2dba83d61..44b18f29e 100644 --- a/docs/source/about/targets.rst +++ b/docs/source/about/targets.rst @@ -18,4 +18,4 @@ Example: Cluster 1 has following Mini-Grids; MG-1 MG-2 and MG-3 +-------------------+--------+--------+--------+ The result of the cluster overview page would be 800 for expected new -connections. \ No newline at end of file +connections. diff --git a/docs/source/about/targets_sidebar.rst b/docs/source/about/targets_sidebar.rst new file mode 100644 index 000000000..f3a05caf6 --- /dev/null +++ b/docs/source/about/targets_sidebar.rst @@ -0,0 +1,18 @@ +Targets (Sidebar) +----------------- + +By clicking on ``Targets`` in the sidebar will load a page +with already set targets. The list shows only the key fields of each +target. To see the details of a target, click on the ``Expand`` button. + +To add a **new Target** just click on the ``New Target`` on the right +top side. After clicking on that button, a new page will be loaded. +Firstly the manager/admin should assign a Cluster or a Mini-Grid (The +difference is already explained +`here <#Information-before-using-MPManager>`__). Then, the date until +that target is valid should be selected. + +When these two steps are done; Its time to define our target with some +fields like ``New connections``, ``Revenue per Month``,... None of these +fields are marked as required. That means the manager/admin is free to +enter or not to enter a value for each goal. diff --git a/docs/source/index.rst b/docs/source/index.rst index e1a5c767e..afff4e18b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,10 @@ Welcome to the MPM Documentation ================================ +.. WARNING:: + The MPM documentation is currently getting reworked. It might not be fully up-to-date. + Use this rendered documentation with caution. + .. toctree:: :maxdepth: 3 :caption: About MPM @@ -13,6 +17,7 @@ Welcome to the MPM Documentation about/minigriddashboard about/customers about/meters + about/targets_sidebar about/transactions about/tickets about/maintenance diff --git a/docs/source/locales/fr/LC_MESSAGES/about.po b/docs/source/locales/fr/LC_MESSAGES/about.po deleted file mode 100644 index 1677c5f10..000000000 --- a/docs/source/locales/fr/LC_MESSAGES/about.po +++ /dev/null @@ -1,519 +0,0 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) 2020, Inensus -# This file is distributed under the same license as the MPManager package. -# FIRST AUTHOR , 2020. -# -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: MPManager \n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2020-11-30 16:15+0300\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.9.0\n" - -#: ../../about/beforeusing.rst:2 -msgid "Before using MPManager" -msgstr "" - -#: ../../about/beforeusing.rst:4 -msgid "" -"The key component(s) of the system is a mixture of meter/customer. That " -"means both melts into each other a bit. The only way to register a " -"customer or a meter is to register them both at the same time. For that " -"reason from now on, every registered person will be mentioned as a " -"**customer**." -msgstr "" - -#: ../../about/beforeusing.rst:11 -msgid "Register a customer & meter" -msgstr "" - -#: ../../about/beforeusing.rst:13 -msgid "" -"There is an additional `Android Application `__ that should be used to register a " -"customer with a meter together. The application allows you to select the " -"village where the customer lives, the meter manufacturer, and the energy " -"tariff that should be assigned to the meter." -msgstr "" - -#: ../../about/beforeusing.rst:21 -msgid "Tariffs" -msgstr "" - -#: ../../about/beforeusing.rst:23 -msgid "" -"Its basically the energy price per kWh with an optional access " -"rate/subscription fee. The operator is free to define the period of that " -"fee. Ex: Every 7 days." -msgstr "" - -#: ../../about/beforeusing.rst:28 -msgid "Payment Channels" -msgstr "" - -#: ../../about/beforeusing.rst:30 -msgid "" -"or now, the system supports only incoming payments from Airtel Tanzania " -"and Vodacom Tanzania. Both providers are accepting Mobile Money and " -"notify the MPManager over a secure tunnel." -msgstr "" - -#: ../../about/beforeusing.rst:35 -msgid "Payments" -msgstr "" - -#: ../../about/beforeusing.rst:37 -msgid "" -"Each incoming payment has to contain the meter number. That is the unique" -" number that is used to identify the other channels where the money could" -" spend. After payment is been received the system automatically checks " -"these further points; 1. Missing Asset Type Rates 2. Not paid Access " -"Rates 3. Convert the money to energy and generate an STS-Token for the " -"calculated energy amount. At the end of the payment process, the customer" -" will be notified about each step." -msgstr "" - -#: ../../about/beforeusing.rst:45 -msgid "" -"At the end of the payment process the customer will be notified about " -"each step." -msgstr "" - -#: ../../about/beforeusing.rst:48 -msgid "" -"If the entered meter number is not valid the system refuses the payment " -"automatically." -msgstr "" - -#: ../../about/beforeusing.rst:52 -msgid "Selling an Asset" -msgstr "" - -#: ../../about/beforeusing.rst:54 -msgid "" -"The system supports to sell assets to customers on a rate basis plan. A " -"water pump or a milling machine will be a good example of that." -msgstr "" - -#: ../../about/clusterdashboard.rst:2 -msgid "Cluster Dashboard" -msgstr "" - -#: ../../about/clusterdashboard.rst:4 -msgid "" -"The cluster dashboard is built similar to the clusters dashboard. There " -"are small informative boxes at the top of the screen. The financial " -"overview and the map are based on Mini-Grids instead of clusters." -msgstr "" - -#: ../../about/clusterdashboard.rst:8 -msgid "" -"There are two new sections available; 1. Revenue Analysis: That is the " -"place where all targets of MiniGrids are shown together. 2. Revenue " -"Trends: That is a chart that breaks down the revenue to customer groups." -msgstr "" - -#: ../../about/customers.rst:2 -msgid "Customers" -msgstr "" - -#: ../../about/customers.rst:4 -msgid "" -"MPManager customers are listed under ``Customers`` in the sidebar. This " -"table contains the customers' name, phone number, city, and meter number." -" The search function also includes all those fields." -msgstr "" - -#: ../../about/customers.rst:8 -msgid "" -"By clicking on a customer, will load the details of that specific " -"customer." -msgstr "" - -#: ../../about/customers.rst:11 -msgid "This ``customer details`` page shows all information about that customer." -msgstr "" - -#: ../../about/customers.rst:14 -msgid "" -"Such as - Basic Details: Name, Surname, Birth Date, etc. - Payment flow: " -"Is a chart that shows how often the customer makes payments - Addresses: " -"A list of the addresses that belong to the customer. - Sold Assets: The " -"assets, that bought by the customer. - A detailed list of the payments. -" -" Payment types: Shows how the sent money is neem spent (Energy, Access " -"Rate payment, etc.). - List of tickets that belong to the customer. - A " -"list of the meters which belong to the customer and a map where the " -"meters are visually displayed." -msgstr "" - -#: ../../about/customers.rst:23 -msgid "" -"Some of the elments are editable (ex:name,surname) or addable (ex:ticket," -" address)." -msgstr "" - -#: ../../about/maintenance.rst:2 -msgid "Maintenance" -msgstr "" - -#: ../../about/maintenance.rst:4 -msgid "" -"In some cases, it is wiser to use external resources to solve small " -"problems. Maintenance is exactly for that there. The maintenance users " -"are some experts who are not working for the company but works per " -"contract." -msgstr "" - -#: ../../about/maintenance.rst:9 -msgid "" -"There is a form to create a **New Maintenance Request**. That page asks " -"the manager/admin about the job todo, the deadline for the task, the " -"person who is responsible to do that, and the price for the task. The " -"created task will be sent out to the external person via SMS. The created" -" maintenance job/task is also saved as a ticket. The gain by saving that " -"task as a ticket is, in case of a problem the person who is assigned to " -"that job can reply to the initial SMS. The incoming SMS will " -"automatically add to the ticket as a response." -msgstr "" - -#: ../../about/meters.rst:2 -msgid "Meters" -msgstr "" - -#: ../../about/meters.rst:4 -msgid "" -"The ``Meters`` link on the sidebar loads a list that contains all " -"registered meters with some additional details such as its serial number," -" assigned tariff, etc.. The search area on the page searches in " -"``serial_number`` and ``tariff name``." -msgstr "" - -#: ../../about/meters.rst:9 -msgid "" -"By clicking on a meter in the list, a new ``meter detail`` page will be " -"loaded. This page, contains ``basic information``, ``meter details``, and" -" ``meter transactions``. If the meter can send its usage data it also " -"shows it in an additional ``meter reading`` section. The ``Basic " -"Information`` section contains the total revenue that the meter made, the" -" owner, when the last payment occurs, and the registration date. ``Meter " -"Details`` are meter specified details such as the manufacturer name, the " -"serial number, assigned tariff, and its connection type. ``Meter " -"transactions`` is a basic list that contains all transactions that hit " -"the meter." -msgstr "" - -#: ../../about/meters.rst:20 -msgid "" -"## Targets By clicking on ``Targets`` in the sidebar will load a page " -"with already set targets. The list shows only the key fields of each " -"target. To see the details of a target, click on the ``Expand`` button." -msgstr "" - -#: ../../about/meters.rst:24 -msgid "" -"To add a **new Target** just click on the ``New Target`` on the right top" -" side. After clicking on that button, a new page will be loaded. Firstly " -"the manager/admin should assign a Cluster or a Mini-Grid (The difference " -"is already explained `here <#Information-before-using-MPManager>`__). " -"Then, the date until that target is valid should be selected." -msgstr "" - -#: ../../about/meters.rst:31 -msgid "" -"When these two steps are done; Its time to define our target with some " -"fields like ``New connections``, ``Revenue per Month``,... None of these " -"fields are marked as required. That means the manager/admin is free to " -"enter or not to enter a value for each goal." -msgstr "" - -#: ../../about/minigriddashboard.rst:2 -msgid "Mini-Grid Dashboard" -msgstr "" - -#: ../../about/minigriddashboard.rst:4 -msgid "" -"Mini-grids are the building blocks of clusters. This dashboard provides " -"information about the selected Mini-Grid, such as **revenue per " -"customer**, **targeted revenue per customer type**, **energy sold**, " -"**actual payment** ,and **the daily weather forecast** is the area where " -"it can observe and analyze the income distribution of the selected Mini-" -"Grid." -msgstr "" - -#: ../../about/minigriddashboard.rst:11 -msgid "" -"Also on this page, the status of **tickets** created by customers in the " -"related Mini-Grid can be observed." -msgstr "" - -#: ../../about/mpmanager.rst:2 -msgid "MPManager" -msgstr "" - -#: ../../about/mpmanager.rst:4 -msgid "" -"**Note: The pages that contain only a ``List of X`` and a ``Add new X`` " -"button without any other key feature are not explained below.**" -msgstr "" - -#: ../../about/mpmanager.rst:8 -msgid "Clusters Dashboard" -msgstr "" - -#: ../../about/mpmanager.rst:10 -msgid "" -"It is basically the whole overview of the business. It shows some quick " -"information like total revenue, registered meters and the number of " -"registered clusters." -msgstr "" - -#: ../../about/mpmanager.rst:14 -msgid "" -"There are also more sections; 1. **Financial overview:** That breaks the " -"total revenue to Mini-Grid level. The manager can see/analyse each Mini-" -"Grid with that. 2. **Cluster Map:** The maps shows graphically where the " -"clusters are located. The clusters on the map are clickable and forwards " -"the manager to the next level dashboard **Cluster Dashboard**" -msgstr "" - -#: ../../about/mpmanager.rst:21 -msgid "" -"To register a new cluster find the red plus button on the right bottom " -"corner of the screen." -msgstr "" - -#: ../../about/reports.rst:3 -msgid "Reports" -msgstr "" - -#: ../../about/reports.rst:5 -msgid "" -"MPManager has a reports page where managers can download reports. This " -"page contains weekly, monthly, and payment requests." -msgstr "" - -#: ../../about/sms.rst:2 -msgid "Sms" -msgstr "" - -#: ../../about/sms.rst:4 -msgid "" -"Sms is the key communication infrastructure. It is used by " -"``Transactions`` and ``Maintenance``. But what if the company wants to " -"send some inform their customers about something like an unplanned " -"electricity cut. That is the reason why ``Sms``\\ is listed in the " -"sidebar as an extra service." -msgstr "" - -#: ../../about/sms.rst:10 -msgid "" -"The manager/admin can send SMS's to a specific Mini-Grid, to a specific " -"customer group/type or single customers." -msgstr "" - -#: ../../about/targets.rst:2 -msgid "Targets" -msgstr "" - -#: ../../about/targets.rst:4 -msgid "" -"A target can be assigned to a whole cluster or for a single Mini-Grid. " -"The important thing by assigning a target is;" -msgstr "" - -#: ../../about/targets.rst:7 -msgid "" -"If the target is assigned to a cluster, the manager will see only that " -"target on the cluster dashboard. However, if a single Mini-Grid or all " -"Mini-Grids in a cluster has a defined target. The manager will see the " -"calculated sum of these targets." -msgstr "" - -#: ../../about/targets.rst:12 -msgid "Example: Cluster 1 has following Mini-Grids; MG-1 MG-2 and MG-3" -msgstr "" - -#: ../../about/targets.rst:15 -msgid "#" -msgstr "" - -#: ../../about/targets.rst:15 -msgid "MG-1" -msgstr "" - -#: ../../about/targets.rst:15 -msgid "MG-2" -msgstr "" - -#: ../../about/targets.rst:15 -msgid "MG-3" -msgstr "" - -#: ../../about/targets.rst:17 -msgid "New Connections" -msgstr "" - -#: ../../about/targets.rst:17 -msgid "100" -msgstr "" - -#: ../../about/targets.rst:17 -msgid "200" -msgstr "" - -#: ../../about/targets.rst:17 -msgid "500" -msgstr "" - -#: ../../about/targets.rst:20 -msgid "" -"The result of the cluster overview page would be 800 for expected new " -"connections." -msgstr "" - -#: ../../about/terms.rst:2 -msgid "Terms" -msgstr "" - -#: ../../about/terms.rst:4 -msgid "" -"**Mini-Grid:** It is an off-grid electricity distribution network that " -"includes small/medium-scale electricity generation." -msgstr "" - -#: ../../about/terms.rst:7 -msgid "**Cluster:** The area that covers the grouped Mini-Grids." -msgstr "" - -#: ../../about/terms.rst:9 -msgid "" -"**Customer:** It defines individual clients and businesses registered in " -"MPManager." -msgstr "" - -#: ../../about/terms.rst:12 -msgid "**Meter:** A pre-paid energy meter that works with an STS-Token." -msgstr "" - -#: ../../about/terms.rst:14 -msgid "**Transaction:** Incoming payments from customers." -msgstr "" - -#: ../../about/terms.rst:16 -msgid "" -"**Ticket:** It is the place where customer problems, complaints, and " -"demands are collected." -msgstr "" - -#: ../../about/terms.rst:19 -msgid "" -"**Tariff:** The combination of energy(kWh) price and the fixed " -"price(access rate)." -msgstr "" - -#: ../../about/terms.rst:22 -msgid "" -"**Target:** It is a goal for a Mini-Grid/ Cluster that the company wants " -"to reach at a given time." -msgstr "" - -#: ../../about/terms.rst:25 -msgid "" -"**Asset Type:** An object, that could be sold to locals to help/improve " -"their productivity or live quality." -msgstr "" - -#: ../../about/terms.rst:28 -msgid "" -"**Maintenance:** This is the place where external contractors are " -"assigned to predefined jobs like \"connect a new house-hold to the " -"grid\", \"replacing not working meters, etc.\"." -msgstr "" - -#: ../../about/tickets.rst:2 -msgid "Tickets" -msgstr "" - -#: ../../about/tickets.rst:4 -msgid "" -"MPManager is using `Trello `__ as a ticketing " -"platform. All tickets are basically Trello cards. The database is only " -"holding references to the tickets. The ticketing system aims to resolve " -"requests and complaints from customers as quickly as possible. It is " -"important to assign a ticket to the correct category to maintain tickets " -"easily. Therefore, there are some ticket categories. To add/ list " -"category please click on ``Categories`` that is listed under ``Tickets`` " -"in the sidebar." -msgstr "" - -#: ../../about/tickets.rst:14 -msgid "Adding User to Ticketing System" -msgstr "" - -#: ../../about/tickets.rst:16 -msgid "" -"As already mentioned, the ticketing system is using Trello. To be able to" -" assign tickets internally, all the staff has to be registered on `Trello" -" `__. The user name is been used to associate the " -"Trello user to MPManager users." -msgstr "" - -#: ../../about/tickets.rst:21 -msgid "" -"To add a user click on ``Users`` in the list below ``Tickets``. It will " -"ask you the ``Ticketing System Tag``. That is the name that begins with " -"an **@** in the Trello user profile." -msgstr "" - -#: ../../about/transactions.rst:2 -msgid "Transactions" -msgstr "" - -#: ../../about/transactions.rst:4 -msgid "The page contains two main sections." -msgstr "" - -#: ../../about/transactions.rst:6 -msgid "" -"The comparison section; gives a quick overview of the situation. That " -"section contains; Total incoming transactions, Confirmed Transactions, " -"Cancelled Transactions, and the Revenue. The part which makes that " -"information a bit interesting is the availability of comparison. The " -"manager/admin can compare the day with; yesterday, same day last week, or" -" the current week with last week or the current month with last month." -msgstr "" - -#: ../../about/transactions.rst:14 -msgid "" -"A basic list with incoming transactions. The list has an advanced " -"filtering option instead of a basic search as in other pages." -msgstr "" - -#: ../../about/transactions.rst:17 -msgid "" -"By clicking on a Transaction, the ``Transaction detail`` page will load. " -"The detail page contains the ``Mobile Provider-specific data``, ``Basic " -"Data``, ``Sent Sms``, and ``Transaction Processing``." -msgstr "" - -#: ../../about/transactions.rst:21 -msgid "" -"**Mobile Money Provider-specific data:** The name of the provider and the" -" transaction details. This information is required by the mobile money " -"provider in case of an issue." -msgstr "" - -#: ../../about/transactions.rst:25 -msgid "" -"**Transaction Processing:** A detailed list that shows how the incoming " -"money is been used by the system. Ex: 100$ for Energy, 20$ for Access " -"Rate, and 400$ for Milling Machine Rate Payment." -msgstr "" - diff --git a/docs/source/locales/fr/LC_MESSAGES/index.po b/docs/source/locales/fr/LC_MESSAGES/index.po deleted file mode 100644 index 1abcb41e9..000000000 --- a/docs/source/locales/fr/LC_MESSAGES/index.po +++ /dev/null @@ -1,31 +0,0 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) 2020, Inensus -# This file is distributed under the same license as the MPManager package. -# FIRST AUTHOR , 2020. -# -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: MPManager \n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2020-11-30 16:17+0300\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.9.0\n" - -#: ../../index.rst:4 -msgid "About MPM" -msgstr "" - -#: ../../index.rst:22 -msgid "Getting Started" -msgstr "" - -#: ../../index.rst:2 -msgid "Welcome to the MPM Documentation" -msgstr "" - diff --git a/docs/source/locales/fr/LC_MESSAGES/installation.po b/docs/source/locales/fr/LC_MESSAGES/installation.po deleted file mode 100644 index b96dbd7a4..000000000 --- a/docs/source/locales/fr/LC_MESSAGES/installation.po +++ /dev/null @@ -1,364 +0,0 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) 2020, Inensus -# This file is distributed under the same license as the MPManager package. -# FIRST AUTHOR , 2020. -# -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: MPManager \n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2020-11-30 16:15+0300\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.9.0\n" - -#: ../../installation/api.rst:2 -msgid "Generate API Documentation" -msgstr "" - -#: ../../installation/api.rst:4 -msgid "" -"To generate the API documentation, jump in the ``laravel`` container and " -"type ``php artisan apidoc:generate`` in the **mpmanager** directory. That" -" will create a new **docs** folder under **public** folder. The API " -"documentation should be available under ``http://mpmanager.local/docs/``." -" The whole API documentation will be migrated to third-party tools like " -"Postman or Swagger." -msgstr "" - -#: ../../installation/deployproduction.rst:2 -msgid "Deploy for Production" -msgstr "" - -#: ../../installation/deployproduction.rst:4 -msgid "" -"The production mode will automatically install **Let's Encrypt SSL " -"certificates**. Therefore you need firstly register a domain." -msgstr "" - -#: ../../installation/deployproduction.rst:7 -msgid "" -"When you have your domain, the first thing to do is editing ``app.conf`` " -"and ``db.conf``\\ (if you planning to use phpMyAdmin as well) files under" -" ``NginxProxy/conf.p``." -msgstr "" - -#: ../../installation/deployproduction.rst:11 -msgid "" -"Afer that, paste ``chmod +x ./install-production.sh`` to make the file " -"executable and run it via ``./install-production.sh``. This will guide " -"you through the installation and finally, it will start the services." -msgstr "" - -#: ../../installation/development.rst:2 -msgid "Development" -msgstr "" - -#: ../../installation/development.rst:4 -msgid "" -"The development environment is served under **http://mpmanager.local** To" -" reach the site over the given url; enter the following lines to your " -"hosts file." -msgstr "" - -#: ../../installation/development.rst:9 -msgid "For Linux/Mac Users" -msgstr "" - -#: ../../installation/development.rst:18 -msgid "For Windows" -msgstr "" - -#: ../../installation/essential.rst:2 -msgid "Essential Configurations" -msgstr "" - -#: ../../installation/essential.rst:4 -msgid "" -"There are bound services like the Payment Services (Vodacom Tanzania and " -"Airtel Tanzania), Ticketing Service(Trello API), Critical Logging " -"notification(Slack Channel), WebSocket(Pusher), etc. if you plan to get " -"your payments through these services you need to change/edit following " -"files/configurations" -msgstr "" - -#: ../../installation/essential.rst:11 -msgid "Mobile Payment Configurations - Vodacom" -msgstr "" - -#: ../../installation/essential.rst:13 -msgid "" -"``ips`` array element in ``services.php``. The file is located under " -"``app/config/``. The element ``ips`` holds a list of authorized IP-" -"addresses that are allowed to send transaction data." -msgstr "" - -#: ../../installation/essential.rst:16 -msgid "Following changes should be done in the ``.env`` file" -msgstr "" - -#: ../../installation/essential.rst:29 -msgid "Mobile Payment Configurations - Airtel" -msgstr "" - -#: ../../installation/essential.rst:31 -msgid "" -"When we set up the second payment provider in our live system, we were " -"not that experienced by setting up **VPN Tunnels** that's why we go with " -"the idea 'one tunnel per host\\`. Thatswhy the airtel payment integration" -" is on a separate project for now. We're planning to migrate it into this" -" project soon." -msgstr "" - -#: ../../installation/essential.rst:37 -msgid "" -"--> **The project link comes as soon as we uploaded the project to " -"GitHub** <--" -msgstr "" - -#: ../../installation/essential.rst:40 -msgid "Change the ``api_user``, ``api_password``, and ``ips`` in ``services.php``" -msgstr "" - -#: ../../installation/essential.rst:54 -msgid "The following change should be done in the ``.env`` file" -msgstr "" - -#: ../../installation/essential.rst:61 -msgid "STS Meter Configuration" -msgstr "" - -#: ../../installation/essential.rst:63 -msgid "" -"Currently, the system supports only CALIN-STS meters. To be able to " -"communicate with Calin and generate STS-Tokens, the following changes " -"should be done;" -msgstr "" - -#: ../../installation/essential.rst:67 -msgid "Your key and the endpoint where you create those tokens." -msgstr "" - -#: ../../installation/essential.rst:74 -msgid "" -"If you have meters which can send their consumption data to CALIN's " -"server please fill the below-listed variables too" -msgstr "" - -#: ../../installation/essential.rst:84 -msgid "Pusher(Web Socket)" -msgstr "" - -#: ../../installation/essential.rst:86 -msgid "Pusher is used to notify your admins when a new ticket is been created." -msgstr "" - -#: ../../installation/essential.rst:97 -msgid "Slack" -msgstr "" - -#: ../../installation/essential.rst:99 -msgid "" -"Slack is the current critical logging service that alerts the admins when" -" something went wrong. Like a transaction is been canceled." -msgstr "" - -#: ../../installation/essential.rst:107 -msgid "Setup Sms Communication" -msgstr "" - -#: ../../installation/essential.rst:110 -msgid "Configuration for BongoLive" -msgstr "" - -#: ../../installation/essential.rst:112 -msgid "" -"**Important Note: The Bongo API integration on our system is not been " -"maintained since early-2019.**" -msgstr "" - -#: ../../installation/essential.rst:115 -msgid "" -"Firstly, you have to uncomment these lines in " -"``app/Providers/AppServiceProvider.php``. Because the default SMSProvider" -" is the 2nd option above." -msgstr "" - -#: ../../installation/essential.rst:125 -msgid "After that, change the following configuration" -msgstr "" - -#: ../../installation/essential.rst:138 -msgid "Configuration for SMS-Gateway Application" -msgstr "" - -#: ../../installation/essential.rst:140 -msgid "**Advice: Please read the SMS-Gateway documentation before you continue.**" -msgstr "" - -#: ../../installation/essential.rst:143 -msgid "" -"To lower the costs of the system we are using the following application " -"to send and receive SMSes over that application. To be able to use the " -"application you need to assign following configuration values in " -"``services.php``" -msgstr "" - -#: ../../installation/essential.rst:148 -msgid "" -"You are not forced to use our inhouse solution for SMS communication. You" -" can change the SmsProvider easily in " -"``app/Providers/AppServiceProvider.php``" -msgstr "" - -#: ../../installation/essential.rst:170 -msgid "" -"**Dont forget to change the ``callback`` variable to a globaly reachable " -"domain**" -msgstr "" - -#: ../../installation/essential.rst:174 -msgid "Change Predefined SMS Text" -msgstr "" - -#: ../../installation/essential.rst:176 -msgid "To change the predefined SMS texts, please edit ``app/Sms/SmsTypes.php``" -msgstr "" - -#: ../../installation/essential.rst:179 -msgid "Weather Data" -msgstr "" - -#: ../../installation/essential.rst:181 -msgid "" -"The system shows the weather data on the Mini-Grid level. To be able to " -"read out the data from ``Open Weather Map`` service you have to register " -"yourself there and get an **API-KEY** Change the following value in " -"``services.php``" -msgstr "" - -#: ../../installation/essential.rst:193 -msgid "Email" -msgstr "" - -#: ../../installation/essential.rst:195 -msgid "To be able to send E-Mails please edit following configuration variables" -msgstr "" - -#: ../../installation/essential.rst:211 -msgid "" -"There are currently two supported SMS-Gateways. 1. Bongo Live Tanzania 2." -" Inhouse SMS-Gateway Application" -msgstr "" - -#: ../../installation/frontend.rst:2 -msgid "Building the Frontend" -msgstr "" - -#: ../../installation/frontend.rst:4 -msgid "" -"The project will automatically build the frontend in the **production** " -"mode. If you want to build the project in **development** mode, change " -"``NMP_MODE`` variable in the ``.env`` file." -msgstr "" - -#: ../../installation/installation.rst:2 -msgid "Installation MPM" -msgstr "" - -#: ../../installation/installation.rst:5 -msgid "System Requirements" -msgstr "" - -#: ../../installation/installation.rst:7 -msgid "PHP ^7.3" -msgstr "" - -#: ../../installation/installation.rst:9 -msgid "Node ^v14.3" -msgstr "" - -#: ../../installation/installation.rst:12 -msgid "Installation" -msgstr "" - -#: ../../installation/installation.rst:14 -msgid "Clone or download the repository" -msgstr "" - -#: ../../installation/installation.rst:15 -msgid "Build the docker containers with ``docker-compose up``" -msgstr "" - -#: ../../installation/installation.rst:18 -msgid "Installing Dependencies" -msgstr "" - -#: ../../installation/installation.rst:20 -msgid "" -"All dependencies will be automatically installed on the installation " -"step. However, if you need additional dependencies, install them in the " -"``laravel`` container. To Install additional php dependencies enter the " -"Docker-Container named ``laravel`` navigate to ``mpmanager`` & run ``php " -"../composer.phar install XXX``" -msgstr "" - -#: ../../installation/installation.rst:27 -msgid "Migrate the database" -msgstr "" - -#: ../../installation/installation.rst:29 -msgid "" -"Run ``docker exec -it laravel /bin/bash`` to jump into the laravel " -"container" -msgstr "" - -#: ../../installation/installation.rst:31 -msgid "navigate to ``mpmanager`` directory with ``cd mpmanager``" -msgstr "" - -#: ../../installation/installation.rst:32 -msgid "" -"Run ``php artisan migrate --seed`` to initialize the Database. The " -"``--seed`` option will create the default user to login." -msgstr "" - -#: ../../installation/installation.rst:34 -msgid "The default user to login is ``admin@admin.com`` and ``basic-password``." -msgstr "" - -#: ../../installation/installation.rst:38 -msgid "Installing Customer Registration App (Android)" -msgstr "" - -#: ../../installation/installation.rst:40 -msgid "" -"Please read the project documentation to get an idea of why we're using a" -" separate app to register customers via an Android-App. Follow the link " -"to get to the Customer Register App Project" -msgstr "" - -#: ../../installation/phpmyadmin.rst:2 -msgid "phpMyAdmin" -msgstr "" - -#: ../../installation/phpmyadmin.rst:4 -msgid "" -"To project also includes phpMyAdmin which enables quick database " -"operations without installing third-party software or writing any single " -"line into the terminal." -msgstr "" - -#: ../../installation/phpmyadmin.rst:8 -msgid "The default credentials for the database are;" -msgstr "" - -#: ../../installation/phpmyadmin.rst:15 -msgid "**Please don't forget to change these before you publish your project**" -msgstr "" -