from ad756e798439243b615d5553c3d9d8c0b24979a8

msupply-foundation · Oct 17, 2024 · 8e514de · 8e514de
1 parent f489890
commit 8e514de
Show file tree

Hide file tree

Showing 27 changed files with 410 additions and 191 deletions.
diff --git a/README.md b/README.md
@@ -5,25 +5,59 @@ Documentation is stored in markdown files and built using [zola](https://www.get
 
 ## Getting Started
 
-To edit the docs, first clone this repo locally. Then install zola: https://www.getzola.org/documentation/getting-started/installation/
+This process has become slightly convoluted because zola to beginwith, but further because we use an outdated version of zola and installing it locally is no longer straightforward. We must use no more than version 17.2 of Zola, not 19.2 which is the latest as of writing.
 
-You should be able to run the docs locally now, by opening a terminal or command prompt, navigating to the directory you've cloned into and entering
+### MacOS
 
-```
-zola serve
-```
+#### Install Github Desktop
 
-The docs will then be available to view locally on http://localhost:1111
+Git is a tool for managing codebases, and our docs are managed like a codebase. Github Desktop is an app that makes 99% of what you need to do with git actually user friendly, rather than user nightmare. https://desktop.github.com/download/
 
-If you encounter an error:
+#### Clone This Repo(sitory)
 
+In this webpage, near the top-ish right there is a green "Code" button. Click it and select "Open in Github Desktop".
+
+![image](https://github.com/user-attachments/assets/7655cf5f-5a51-4774-9287-076d2cc01589)
+
+Follow the prompts and let it clone the repo to your machine.
+
+#### Dev bonus to build from source instead
+
+<details>
+
+1. Clone Zola the same way as above with "Open in Github Desktop": https://github.com/getzola/zola
+2. In github desktop*, click on the "History" tab then scroll down and select the _commit_ that is tagged `v0.17.2`, right click and choose "Checkout Commit" ![image](https://github.com/user-attachments/assets/ec8cc390-c11f-49b4-bc61-2dda56957da1)
+3. Install rust. You're a programmer Harry! https://www.rust-lang.org/tools/install
+4. Open a terminal in your Zola repo directory. You can do this in github desktop in the "Repository" Menu "Open in Terminal", or navigate a terminal window there if you're in the know.
+5. Run the command `cargo install --path . --locked` - this will use rust to build zola and install it
+6. Run `Zola --version` and pray that you are on `0.17.2`
+
+*Or cause you're a dev and cbf clicking around in github desktop just do:
+
+```shell
+git clone https://github.com/getzola/zola.git
+cd zola
+git checkout v0.17.2
+cargo install --path . --locked
+zola --version
 ```
-Error: Failed to render section '/Users/m2/GitHub/msupply_docs/content/_index.md'
-Reason: Failed to render 'index.html': error while rendering macro `macros_header::header` (error happened in a parent template)
-Reason: Variable `config.default_language` not found in context while rendering 'macros/header.html'
-```
 
-ensure that you are running the most recent version of zola. There is a problem with `v0.14.0`. You can check with `zola --version`
+</details>
+
+#### Download Zola and Convince MacOS it is safe
+
+1. Download [the terminal executable program for your OS](https://github.com/getzola/zola/releases/download/v0.17.2/zola-v0.17.2-x86_64-apple-darwin.tar.gz) from https://github.com/getzola/zola/releases/tag/v0.17.2
+2. Extract it and copy `zola` file to `/usr/local/bin/` (pressing `cmd+shift+.` in a finder window will toggle showing hidden folders 🙂)
+3. In a terminal try run `zola`. It'll complain about malware, at which point you can allow it in settings 
+![image](https://github.com/user-attachments/assets/6d9869d0-86e9-49e3-9e04-f35481a30d94)
+4. Run `zola --version` and if it says 0.17.2 you're good to go!
+
+#### Serve our docs with Zola!
+
+1. Open a terminal in the `msupply_docs` directory on your machine
+2. Run `zola serve`
+3. This will typically make the docs available on `http://localhost:1111`, it'll say where exactly after you run the above command.
+4. Woo! Now if you make any updates to msupply_docs files, zola will detect the changes and refresh your browser tab for you.
 
 ## Contributing
 

diff --git a/content/docs/TSS/_index.fr.md b/content/docs/TSS/_index.fr.md
@@ -0,0 +1,10 @@
++++
+title = "TSS"
+description = "Conformité d'Open mSupply avec les Target Software Standards"
+updated = 2021-05-01T08:00:00+00:00
+sort_by = "weight"
+weight = 90
+paginate_by = 0
+template = "docs/section.fr.html"
+insert_anchor_links = "right"
++++
diff --git a/content/docs/TSS/target_software_standards.fr.md b/content/docs/TSS/target_software_standards.fr.md
@@ -0,0 +1,32 @@
++++
+title = "Target Software Standards"
+description = "Conformité d'Open mSupply avec les Target Software Standards"
+date = 2022-03-17T18:20:00+00:00
+updated = 2022-03-17T18:20:00+00:00
+draft = false
+weight = 1
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+toc = true
+top = true
++++
+
+L'objectif de la Fondation mSupply est une conformité à 100% avec les Target Software Standards de l' <a href="https://isghealth.org/">Interagency Supply Chain Group </a> pour les paramètres de ressource bas, médian et haut.
+
+Ces graphiques indiquent le progres actuel d'Open mSupply vers cet objectif. (La couleur mauve indique la conformité dans le cadre d'une utilisation avec l'application mSupply dans un système source hybride ouvert/fermé compliance)
+
+<div {% if class %}class="{{class}}"{% endif %}>
+    <iframe width="821" height="805" frameborder="0" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vRmM6xnuRn6DlZLmaYoZj0RnMFRu2lx5qUM-qN2u_5S6tL7BQfC2zh6PDL43t1fU6ZLwWh3Hwi9AjLj/pubhtml?gid=1488682632&amp;single=true&amp;widget=false&chrome=false&amp;headers=false"></iframe>
+</div>
+
+Vous pouvez voir le détail de la conformité d'Open mSupply avec la version 2.0 de TSS dans le tableau suivant:
+
+Remarque: Un lien vers un tableau pleinement interactif, y compris une vue filtrée est ici <a target="_blank" href="https://docs.google.com/spreadsheets/d/1hc8sG9e7pvKy9r6JKxSe6SM0MjgQwN4VqjiGX90A4BU/edit?usp=sharing
+">here</a>.
+
+<div {% if class %}class="{{class}}"{% endif %}>
+    <iframe width="1230" height="11700" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vRmM6xnuRn6DlZLmaYoZj0RnMFRu2lx5qUM-qN2u_5S6tL7BQfC2zh6PDL43t1fU6ZLwWh3Hwi9AjLj/pubhtml?gid=2092510478&amp;single=true&amp;widget=false&chrome=false&amp;headers=false"></iframe>
+</div>
+
diff --git a/content/docs/coldchain/monitoring.md b/content/docs/coldchain/monitoring.md
@@ -23,7 +23,6 @@ The Monitoring section displays cold chain temperature monitoring data in three
 Temperature data may be imported into Open mSupply via Bluetooth (e.g. <a href="https://msupply.foundation/open-msupply/cold-chain/#mSupplySensor" target="_blank">mSupply temperature sensors</a>) or via USB (e.g. <a href="https://msupply.foundation/open-msupply/cold-chain/#BerlingerSensor" target="_blank">Berlinger Fridge-tags / Q-tags)</a> - see <a href="https://docs.msupply.foundation/docs/coldchain/sensors/#connecting-sensors">Connecting Sensors</a> for more info.
 </div>
 
-
 ### Viewing Monitoring data
 
 Choose `Cold chain` > `Monitoring` in the navigation panel.
@@ -78,11 +77,11 @@ The `Breaches` tab displays a list of all recorded breaches.
 The list of breaches is divided into 10 columns:
 
 | Column           | Description                                                                                                                    |
-| :--------------- | :----------------------------------------------------------------------------------------------------------------------------- |
+|:---------------- |:------------------------------------------------------------------------------------------------------------------------------ |
 |                  | An icon showing an alert if this breach is unacknowledged                                                                      |
 | **Status**       | The breach status can be `Acknowledged` or `Unacknowledged`                                                                    |
 | **Sensor name**  | Name of the Sensor                                                                                                             |
-| **Location**     | Current location linked to the sensor                                                                                        |
+| **Location**     | Current location linked to the sensor                                                                                          |
 | **CCE**          | Name of the cold chain equipment item which the sensor is associated with                                                      |
 | **Breach start** | Date and time at which the breach started                                                                                      |
 | **Breach end**   | Date and time at which the breach ended, if applicable                                                                         |
@@ -145,10 +144,10 @@ The `Log` tab shows a list of all temperature logs.
 The list of temperature logs is divided into 6 columns:
 
 | Column          | Description                                                                                                                                                                            |
-| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|:--------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **Date time**   | Date and time of the most recent activity for this sensor                                                                                                                              |
 | **Sensor name** | Name of the Sensor                                                                                                                                                                     |
-| **Location**    | Current location linked to the sensor                                                                                                                                  |
+| **Location**    | Current location linked to the sensor                                                                                                                                                  |
 | **CCE**         | Name of the cold chain equipment item which the sensor is associated with                                                                                                              |
 | **Temperature** | The most recent temperature reported by the sensor                                                                                                                                     |
 | **Breach type** | If the sensor has had a breach, this shows the type of the most recent breach. This is a combination of Hot or Cold (shown by the icon and text colour) and Consecutive or Cumulative. |
@@ -175,4 +174,3 @@ To add a filter to the page, choose the required filter from the drop down.
 3. You can also select a different number of rows to show per page using the option at the bottom right of the page.
 
 ![Rows per page](/docs/introduction/images/rows-per-page-select.png)
-
diff --git a/content/docs/developer/_index.fr.md b/content/docs/developer/_index.fr.md
@@ -0,0 +1,11 @@
++++
+title = "Pour les développeurs"
+description = "Documentation pour le développement d'Open mSupply"
+date = 2025-05-01T08:00:00+00:00
+updated = 2021-05-01T08:00:00+00:00
+sort_by = "weight"
+weight = 200
+paginate_by = 0
+template = "docs/section.fr.html"
+insert_anchor_links = "right"
++++
diff --git a/content/docs/developer/front_end_plugins.fr.md b/content/docs/developer/front_end_plugins.fr.md
@@ -0,0 +1,27 @@
++++
+title = "Plugins Front-end"
+description = "Plugins pour le développement de Open mSupply"
+date = 2024-06-27T18:20:00+00:00
+updated = 2024-06-27T18:20:00+00:00
+draft = false
+weight = 5
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+toc = true
++++
+
+Nous avons l'intention de créer un site Web de documentation pour les développeurs distinct, mais nous voulions que ces informations soient trouvables jusqu'à ce que nous le fassions. Elles se trouvent ici :
+
+## Pourquoi des Plugins?
+Les plugins vous permettent d'ajouter des fonctionnalités à Open mSupply sans avoir à modifier la base de code principale.
+
+
+## Documentation
+
+Notre dépôt Github contient une explication complète sur la façon de créer des plugins front-end, en Anglais [ici](https://github.com/msupply-foundation/open-mfoundsupply/blob/develop/client/packages/plugins/README.md)
+
+## Exemples
+
+Vous trouverez des exemples de plugins dans le fichier [ici](https://github.com/msupply-foundation/open-msupply-plugins)
diff --git a/content/docs/integrations/DHIS2.fr.md b/content/docs/integrations/DHIS2.fr.md
@@ -0,0 +1,35 @@
++++
+title = "Intégration avec DHIS2"
+description = "Intégration de Open mSupply avec DHIS2"
+date = 2022-03-17T18:20:00+00:00
+updated = 2022-03-17T18:20:00+00:00
+draft = false
+weight = 5
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = "Intégration de Open mSupply avec DHIS2"
+toc = true
++++
+
+## A propos de DHIS2
+DHIS2 est devenu le système d'information sanitaire par défaut utilisé dans les pays à revenu moyen et faible.
+C'est un excellent logiciel qui permet l'intégration de données et la création de tableaux de bors pour la prise de décision au niveau national. Il est important de rappeler que DHIS2 n'est pas un logiciel de gestion des stocks, un aspect essentiel de la logistique. 
+
+Nous intégrons avec DHIS2 de 2 manières.
+
+### Envoi de données logistiques vers DHIS2
+mSupply contient beaucoup de données. N'essayez pas d'envoyer toutes les données de mSupply à DHIS2 - vous ralentirez votre instance DHIS2 au point qu'elle ne sera pas agréable à utiliser.
+Nous vous suggérons d'envoyer des données récapitulatives qui montrent les indicateurs clés de performance. Si une enquête plus approfondie est nécessaire, cela peut être fait avec le tableau de bord d'Open mSupply.
+Données que vous pourriez vouloir envoyer
+* Stock disponible pour les articles clés (exprimé en « mois de stock » de préférence)
+* Données de consommation pour les articles clés
+* Taux de gaspillage
+* Taux de déclaration des installations de niveau inférieur
+
+
+### Intégration avec l'application de gestion des stocks en temps réel de DHIS2
+L'application Real Time Stock Management est destinée à être utilisée dans les points de prestation de services (dispensiation). Si un établissement utilise déjà DHIS2 et n'utilise pas Open mSupply, cette étape intermédiaire est une solution viable. Plus d'information [ici] (https://docs.dhis2.org/fr/implement/logistics/real-time-stock-rts.html)
+Cependant, si vous passez des commandes à l'aide de l'application Real Time Stock Management, vous avez besoin d'un système tel qu'Open mSupply pour recevoir la commande, l'exécuter et envoyer des mises à jour à l'établissement, le cas échéant.
+
diff --git a/content/docs/integrations/HL7_FHIR.fr.md b/content/docs/integrations/HL7_FHIR.fr.md
@@ -1,6 +1,6 @@
 +++
-title = "HL7 (FHIR) Integration"
-description = "Open mSupply Integrations with systems supporting the HL7 FHIR Standard."
+title = "Intégration avec HL7 (FHIR) "
+description = "Intégration de Open mSupply avec les systèmes supportant le standard HL7 FHIR"
 date = 2022-03-17T18:20:00+00:00
 updated = 2022-03-17T18:20:00+00:00
 draft = false
@@ -9,11 +9,11 @@ sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
-lead = "Open mSupply Integrations with systems supporting the HL7 FHIR Standard"
+lead = "Intégration de Open mSupply avec les systèmes supportant le standard HL7 FHIR"
 toc = true
 +++
 
 ## HL7
-HL7 is the internation standard for sharing electronic health information.
+HL7 FHIR est la norme internationale pour le partage d’informations de santé électroniques. est une norme d'interopérabilité de nouvelle génération créée par l'organisme de développement de normes Health Level 7 (HL7®). FHIR est conçu pour permettre l'échange rapide et efficace de données de santé, y compris les données cliniques et administratives.
 
-mSupply can receive patient master records from systems that support HL7 FHIR. This allows you to run an electronic medical record system for patient management, and for patients generated in that system to populate Open mSupply as they are created or updated.
+mSupply peut recevoir des dossiers médicaux principaux de patients provenant de systèmes prenant en charge HL7 FHIR. Cela vous permet d'exécuter un système de dossiers médicaux électroniques pour la gestion des patients et pour les patients générés dans ce système afin de renseigner Open mSupply au fur et à mesure de leur création ou de leur mise à jour.
diff --git a/content/docs/integrations/SAGE.fr.md b/content/docs/integrations/SAGE.fr.md
@@ -0,0 +1,27 @@
++++
+title = "Intégration avec SAGE"
+description = "L'intégration Open mSupply avec SAGE."
+date = 2022-03-17T18:20:00+00:00
+updated = 2022-03-17T18:20:00+00:00
+draft = false
+weight = 5
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = "L'intégration Open mSupply avec le logiciel de comptabilité et de gestion financière SAGE"
+toc = true
++++
+
+## SAGE
+[Sage](https://www.sage.com) est un logiciel de gestion financière dont l'utilisation est répandue dans les dépôts médicaux centraux, notamment dans les pays francophones.
+
+Open mSupply s'intègre à Sage à l'aide d'une application d'interopérabilité personnalisée que la mSupply Foundation a développée et qu'elle maintient.
+
+### Versions de Sage Supportées
+**Sage 100 series** - Possède une interface COM très complexe.
+
+Notre intégration utilise une application personnalisée qui s'exécute sur le serveur SAGE et sert d'intermédiaire entre la l' API d'Open mSupply et l'API (peu avenante) de SAGE 100. ;-)
+
+L'application est bidirectionnelle : elle reçoit les commandes des installations utilisant mSupply et les transmet à SAGE pour exécution. Une fois la commande expédiée depuis SAGE, l'application crée le projet d'expédition entrant correspondant pour l'installation qui a passé la commande, leur permettant de recevoir des marchandises sans saisie de données fastidieuse.
+Le seul travail à effectuer est la vérification du produit, du lot, de la date d'expiration et de la quantité, ainsi que tout ajustement saisi avant que les marchandises puissent être reçues en stock.
diff --git a/content/docs/integrations/_index.fr.md b/content/docs/integrations/_index.fr.md
@@ -1,6 +1,6 @@
 +++
-title = "Integrations"
-description = "Integrations with other systems."
+title = "Intégrations"
+description = "Intégrations avec d'autres systèmes"
 date = 2025-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 sort_by = "weight"

diff --git a/content/docs/introduction/images/roadmap.png b/content/docs/introduction/images/roadmap.png
diff --git a/content/docs/introduction/images/roadmap_es.png b/content/docs/introduction/images/roadmap_es.png
diff --git a/content/docs/introduction/images/roadmap_fr.png b/content/docs/introduction/images/roadmap_fr.png
diff --git a/content/docs/introduction/roadmap.es.md b/content/docs/introduction/roadmap.es.md
@@ -15,34 +15,7 @@ toc = true
 Este mapa de ruta se actualizará aproximadamente cada seis semanas y solo cubre nuestro flujo de trabajo comprometido inmediato. Nuestra lista de funciones planificadas es mucho más extensa.
 
 ### Plan de trabajo
-{% mermaid ()%}
-gantt
- title Plan de Trabajo Open mSupply
- dateFormat YY-MM-DD
- axisFormat %B
- section Versión 1.1
-  Integración de Fridge-tag :t1-1-1,23-02-21, 35d
-  División de paquetes :t1-1-2,23-03-06, 35d
-  Función de programas RC1 :t1-1-3,23-02-01, 30d
-  Estabilización de Android :t1-1-4,23-02-01, 25d
- section Versión 1.2
-  Preferencias: t1-2-3, after t1-1-2, 28d
-  Integración de cadena de frío :t1-2-1, after t1-1-1, 56d
-  Función de programas RC2: t1-2-2, after t1-1-3, 90d
- section Versión 2.0
-  Dispensación: t2-0-1, after t1-2-2, 70d
-  Funcionalidad mejorada de R&R: after t1-2-3, 56d
-  Integración DHIS2: t2-0-3, after t1-2-2, 28d
-  Integración HL7: t2-0-4, after t2-0-3, 28d
-  Dispensación : milestone, m2, after t2-0-1, 
-section Versión 2.1
-  Devoluciones de clientes: t2-1-1, after t2-0-4, 32d
-  Devoluciones de proveedores: t2-1-2, after t2-0-4, 32d
-section Versión 2.2
-  Propiedades de los productos: t3-0-1, after t2-1-1, 14d
-  Serialización: t3-0-2, after t3-0-1, 21d
-  Front-end Marco de complementos: after t2-1-1, 32d
-{% end %} 
+![Plan de trabajo](/docs/introduction/images/roadmap_es.png)
 
 
 ### Características planificadas