documentations templates

REGOVAR · May 10, 2017 · 83a4b9c · 83a4b9c
1 parent 98e39cd
commit 83a4b9c
Show file tree

Hide file tree

Showing 23 changed files with 274 additions and 153 deletions.
diff --git a/docs/en/dev/core.md b/docs/en/dev/core.md
@@ -0,0 +1,9 @@
+# Core
+
+business layer
+
+* FileManager
+* PipelineManager
+* JobManager
+
+* pirus singleton
diff --git a/docs/en/dev/core/containers.md b/docs/en/dev/core/containers.md
@@ -0,0 +1,4 @@
+# Pirus ContainerManager system
+
+Container virtualization abstract interface of Pirus
+
diff --git a/docs/en/dev/core/containers/lxd.md b/docs/en/dev/core/containers/lxd.md
@@ -0,0 +1,5 @@
+# LXD Container Manager
+
+Pirus wrapper to manager LXD container.
+
+* supported/implemented features
diff --git a/docs/en/dev/core/filemanager.md b/docs/en/dev/core/filemanager.md
@@ -0,0 +1,3 @@
+# Core - FileManager
+
+Features
diff --git a/docs/en/dev/core/jobmanager.md b/docs/en/dev/core/jobmanager.md
@@ -0,0 +1,3 @@
+# Core - JobManager
+
+Features
diff --git a/docs/en/dev/core/pipelinemanager.md b/docs/en/dev/core/pipelinemanager.md
@@ -0,0 +1,3 @@
+# Core - PipelineManager
+
+Features
diff --git a/docs/en/dev/model.md b/docs/en/dev/model.md
@@ -1 +1,9 @@
-model
+# Model
+
+data layer
+
+* SqlAlchemy and framework's tools
+* File
+* Pipeline
+* Job
+
diff --git a/docs/en/dev/model/file.md b/docs/en/dev/model/file.md
@@ -0,0 +1,5 @@
+# Model - File
+
+Data schema
+
+Class Description
diff --git a/docs/en/dev/model/job.md b/docs/en/dev/model/job.md
@@ -0,0 +1,7 @@
+# Model - Job
+
+Data schema
+
+Class Description
+
+JobFile class
diff --git a/docs/en/dev/model/pipeline.md b/docs/en/dev/model/pipeline.md
@@ -0,0 +1,5 @@
+# Model - Pipeline
+
+Data schema
+
+Class Description
diff --git a/docs/en/dev/rest_api/file.md b/docs/en/dev/rest_api/file.md
@@ -0,0 +1,3 @@
+# REST api - File
+
+endpoints
diff --git a/docs/en/dev/rest_api/job.md b/docs/en/dev/rest_api/job.md
@@ -0,0 +1,3 @@
+# REST api - Job
+
+endpoints
diff --git a/docs/en/dev/rest_api/pipeline.md b/docs/en/dev/rest_api/pipeline.md
@@ -0,0 +1,3 @@
+# REST api - Pipeline
+
+endpoints
diff --git a/docs/en/dev/rest_api/tus.md b/docs/en/dev/rest_api/tus.md
@@ -0,0 +1,5 @@
+# REST api - TUS
+
+endpoints
+
+workflow
diff --git a/docs/en/dev/welcom.md b/docs/en/dev/welcom.md
@@ -1 +1,40 @@
-welcom
+# Developper Guide
+
+## Pirus, Regovar ?
+Pirus is a "sub" project of the Regovar project. Pirus focus on the server application used by Regovar to run bioinformatics pipelines.
+
+The Regovar community prides itself on being an open, accessible and friendly community for new participants. If you have any difficulties getting involved or finding answers to your questions, please bring those questions to the #regovar chat room on gitter so that we can help you get started.
+
+
+
+
+## What skills do I need ?
+Pirus is a small project but we are using and we are happy to receive contributors with very different skills.
+
+* If you know **C++**, for instance, you can contribute to the heavy client QPirus for the Pirus server.
+* If you know **JavaScript** or **HTML/CSS**, you can contribute to the front-end of Pirus.
+* If you know **Python**, you can contribute to the Pirus server application.
+* If you know **Make**, **shell** or **Python**, you can contribute to our build systems and release engineering and automation.
+* If you know **Linux systems**, **virtualization** technologies (lxc/lxd, docker, biobox, conda, ...) and **Python**, you can contribute to ours ContainerManager, which allow Pirus to support many kind of virtualization technologies.
+* If you know **Markdow** and **ReadTheDoc**, you can help to write, correct, and translate Pirus's documentation.
+* If you know **bioinformatics** technologies, you can use Pirus as user, and test/share your pipelines with us to improve the Pirus server and share your experience with the community.
+
+
+## I found a bug ! I have a new idea !
+
+you can expose it in the #regovar chat room on gitter, or you can create a new issue on github.
+
+
+
+
+
+## Advanced topics
+
+* Coding rules
+* Sofware Architecture
+* Pirus Model
+* Pirus Core
+* Pirus container's managers:
+	* LXD
+* Pirus REST api
+* Pirus CLI api
diff --git a/docs/en/diagrams/architecture_overview.png b/docs/en/diagrams/architecture_overview.png
diff --git a/docs/en/diagrams/architecture_overview.xml b/docs/en/diagrams/architecture_overview.xml
@@ -1 +1 @@
-<mxfile userAgent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.82 Safari/537.36" version="5.7.2.2" editor="www.draw.io" type="device"><diagram>7Vxbd9o4EP41PMLxHfsxCem256S7LCRt9lHYArQxFjUiCf31K9kSlnzhKthcSM9p7LEs2ZpvZr4ZyWnZN7PXP1Iwn37HEYxblhG9tuxey7JMN7DoLyZZ5RLPd3LBJEURb1QIhug35EKDS5coggulIcE4JmiuCkOcJDAkigykKX5Rm41xrI46BxM+olEIhiGIxXN03EL+E0Vkmst9yyvkXyGaTMXYphfkV0YgfJqkeJnwEVuWPc5+8sszIPriIy+mIMIvksi+bdk3KcYkP5q93sCYza6YOHEfWYmnbdnXUzKL6YlJD7PLXxpuNne5mb5dChMiD9fYX5dPyDOIl6JHy4vpzddjTPuQx/J+LbG40F5kSr+iDUxn/lpcpEcT/hvM5vQgGS3Yr/63wcOQth7eDn7cDsQY9MnyYcRNpbd7mSICh3MQsvMXClb1dTM9QfYuBj1bq4KdTGKwWPDjEM9QyI9jMILx9VrJNzjGKb2U4ASyLkiKn6AQUt172Q97aRTHknzssn98MrgBmAY/l9oZ2Q+VgxhNEiqL4Zi96RSn6DdtCsSrPMOUIIrgK96O4Pl6Qtg1+NpSLaBQsbmGHTVoiGeQpCvaRNzgc8RxWzYFAl8Ku3ADLptKNuEIIeDWOFn3XSCKHnBQNQBM2JUCsLem5bWWylrOLX9/LYdUOTDVo0DbNxUFrvUiKXCtVFmBng79dd2KumBEnS0/xSmZ4glOQHxbSCWNmaoq4Ssij9LxP0xfHYsZEp2NdPXI9ZedSBcXBKTkikUGNuYcJkL2BbFH5/dEpRZUIl3/FxKy4koES4KpqHj6O8zsLXuuCjqcHvu3BwryGWPTtFnldFbxMg1FK9fnoRKkEyjaeVY9OFIYA4Ke1RHqNJ3dSicGrKQGc4wSspB67jNBgTkrKDmNwFXjyH7t6UH+BAXm1q+yIwy7dXFKiTBf7+/7tMXgdnhfvlSBMLVGUnIykEY0MMoaMB3yGaKt3euW26uz7bLLnqEoyuDf4H0OcSiN/oNTJ/7EMhOSQJYbb6NnMTqGGah6y8/2A1cFDW3PV2/B4/GCIrrsd/bFgL8rBu4fhp1vf21FgXZH1t3kyLof15E1IqxtdBzfdLWgylVdDBWoPeS+lN+0wVfZ1paOcv+7oSO9sParGYF2YG7C5ceF5Vni685MStC4De7rJxwNcfjEMHUJYIVtbHIvhuF1NQWtkhvQY91ubdDKkt+RSHv7KF1SMmbcxAhmybDIjUdvNzF+0ylTu1uio/5ZU6ZqleYYh76r215r6oO5bc+qc9sNzFZXWnRUQLcqJg+TX0tIT7hpR+hZWDYBiyfJ4qUrn9XndzfbttExrSMJpea0pFrQ0sDfjI5vWxKHM2mu1v1Q7oC9WR+miM41Q2ZPu4uwT+simrIUXwk9tm+UAHZkJcSrepdGQjGE6TMKYT2jqLiiUuE/XOusqO1T7TlhEFTL/f0VxUjSYgb9hc0WwjQVb6zy7+TuLhRnY1XY2k5xLLHcpZ3i5LZVC8IaQI3Sbao/+tYy9PcC/LpND9DYBBYbDWbnRz/EjGY4meCePNYBhkNtYc4Ow1WMqIkwwF1saZMtuXbJZztVW/JqsgVfS7bgnIY+uDJ5eH/kQNCcdQpU0JxDSYJTRxL8/4MkeIGnAM51NJME3zsJqFqNNcUaNb0vwGkF1YmZ5zHZinjgHSN3hVGGUxgtY5juHyI10Er6MpDN0DvZPPKmg55nqz7Ids9ZIxPFVj0EcgBGI0S+/32hQkejwlNRYXbPSIW8ukX+i1HvkxUG6l4h1zhr4ds+PZU1Pg2z0MJMK9TTEam7WP12SppvWP3el+I2jaOP4lYjiLID6JMWzxuoZ7Fg6nrHLphyjbbFOofecrq3x4LpYJmcobZ599jLp58AlCjM91LV1By/HEP1Gq551vhlbOcfUlwJmUKYGmQF6lkXqS/hFGs/RfItYuKhUYZ7UTV/deqVJO8Yr9GBkB27EcMWOapwNGY5Ru261attm+WuypvaG8LdQRGpWhSP4GXdd+fQtXWvj+26anZiHQc4zfv4gtOz3702hGzfx8djxDtjxn7tPr5j6fLOUUJ4kLNmOW9el1JsMt1ARuYas5oW++vVbx2p/lPuB2pmtAfUuoZTOj8RK8USnLLvICtbRaWua77eY9GkzcMD+3yPR4i6D/iyfhZzkNR2FFMy3BbxP/sQsGNVu8mpbvEmeXf7LvI2lfVASif5UtLbGDhts1TorfkA0K+hc6ahg1MHepc3P3vsC+wa5+efL/bVlu0V/9NDKfuk2zKolSUxBsxVPSNA/38Y3F32tctWsXlfu1kq5Tp6sitXzYjcUg96uHDQPY3Vq3lvZVvDR/1ypdbq3fNZfTWxfVgwztAQlpez+CokWDbFO2Z5fbxABGFmkiNMCJ7tZpL1n8YfF+DfVwhvix3PGzYo2aeqiok/BiJp/88JSh4r6v/ANCzKgloO3YT5Bj16tcqbOL3dVlsda3/F0tPir5LkPr344y/27X8=</diagram></mxfile>
+<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36" version="6.5.8" editor="www.draw.io" type="device"><diagram name="Page-1">7Vttc+MmEP41nmk/NCOB3vwx8eXu2snNpJebae8jlrBNIwsNwol9v74ggSwMTuSz7Ly0+WJphQA9+7C77JIRnCzXnxgqF19ohvMR8LL1CH4YAeAHIBI/UrJpJNFYCeaMZI3I2wruyA+s3tTSFclwpWSNiFOac1KawpQWBU65IUOM0Uez2YzmmSEo0RxbgrsU5bb0L5LxRSNN9GdJ+WdM5gs9sh+NmydTlN7PGV0VarwRgLP6r3m8RLov9aHVAmX0sSOC1yM4YZTy5mq5nuBcYmvC9nHP03beDBe8zwtAzfsB5Susp1xPjG80GI8LwvFdiVJ5/ygUPoJXC77MxZ0vLu0h1SweMON43RGpKXzCdIk524gm+mms4FB0AXoWj1vwoyBoZIsO8KGvGiKl8Hnb9/ajxYX67j0YxNYn40zQQd0WtBA/V7VSsXzFM7+/4ojxS0k6IaAlLrTsI5FD1s1xke20EJLO838w5xu1DNCKUyGijC/onBYov6G0fA5rMd4cKxEIG5n8iCfRZzhHnDyYnHchqV69pUQM22oNhsDQmq9Jrbuo6IqlWL21o492Gv1UlLwzFcHzqAiMzYXlJ/BUKoKhZUkmdLlEwhICLyeFMOe7KhTWgZuKYrgiP9C0biBBL+XE6qmGV6Pwg5CgnMyFcj6kAl7MhEBaGSIs96V6sCRZJt+/ytEU51etPZ7QnLJ6XG2RXbrSRLNsV+tr1OwMe+2yab95F37kK9Pys2ps7aH5Bp3NKnz0mrL0taoEortKEh6qlJerZX6ZctqF/EYifEsrwgmV0E8p53TZD/pdtXE6vFsBcWiwXy+GjleBnu1UIm+/fvr6FGiBW8xJsbbQ3Zos+c3PeNqZsEYmliBNa1PG6D3uPMmiaRRGw4AYeDu+2YstFP3Yt2GEA8AYOKKTKJdGYyou5vLi6/XdNzlKSfQj0Wn79B0ADkObtm3ANDRvg/AoR4vXhP/duf4um1yEL+KCd3yrUyuN+1OxpO2mYXykV+4Lu+07LZ5PKMMnZ3iGcDJzMjxKEzx1+8zD7fIOwwPgMMynYvj4OIIPRNE+y6EXa2ObtYmT/2dgcfw8i1Wq4H3S2BVfnIrGyV6sM/KwBXUH/lbAdiWmLlqZo7On+i9pxedMhvre3Z83h/S9J+pMN2LrkNWB/mukQBBBgwKRl1gU0EFolwHj8HgG+HaMacEo4++y/3cevMlpqayXQGQvARHQ2ACEA5gb338eANteuyyvaeA7JriHSe67k+8gEroAUbJjN/yBqZCwX0pmfz/6xcbBDJEo0Cm7/9XWUZN/oJo2zoGGU5JjA2tHpDe/n2njlYU4yQKXMU/AFEYDbbx2/blz45WcyJ/7ruDpha05dAQ0p7Pmrojm7GYhfh1m4Q1Z8x4FpP+M2l6tNX8VkZIasrN5Vek9I+XyOjSpFk4IgWkRo/jCg2Pgh1ESgTgI+5VTnu0X6PrxCXQf2ao+KOEhRpIpvSaNV99+7+r8pctqXT45c3g9CTV4NsSR1Cswf6Ts3lZInpOyknpo9705XWXPx0n9g4H9W1hNEEXFxBH0AMcKSwYIeqBvQ/HWyrpd/umSR5d/fV3T4PzTk3kqhBdAYNHkblNxvOwVxmuCFpTjV5qUaQ/XtEmZyKK0K4wfxwOAbm9uP2P0IGcn+wDeTT2enUqb5ER+cb/smF04NwFVC6eLvhL1L5+7NDuAciAcG8rxoW1vtCKMauIQKyKylHNL2KrOVmL24Ch+vxTQM1pwbQX3V6+GPWCVjG3Ud0/0/FRJ8Tgjr0uKKv7QRcUXMf+HlhShozoDk3PZ/x7lmIngGSIFZl9QgeZyAezP2Dvy/kQLfsnX2QiIKXkZTe9lP/J6SuiUrpvri4uLXzu9kwPrAWepBjkyKJaC9y6xCJiGzVXU9ENHLWCQsr3tdiwIO9mj3qmigwDwzdM2IHQcFImADYB1bvCn2N4jD9EG16tpj9ilaqyC79mMwn4W4tjFqHEUQxT1ZVSjNhvR1jfaAJ4qFA9c0eJbxW89MlbFWbYyhxVk2dP27+uqEH3dkhLLk5OOjpAMWv6g0kijpQS+mFZlp7uqRIVuSwrh1/a0E8N2mx5c+e2+nGpnUh3Y+xunmQ5NN+ZKOsuqhcPEVqO3d1xLG/xubBWcKbQK7HOJ9Vr0xK6YzESULw/E9jnvfM5t21HRTagPnGjn7igNJY7gBh6+pxa32/9/aRKe238ygtf/Ag==</diagram></mxfile>
diff --git a/docs/en/diagrams/run_states.png b/docs/en/diagrams/run_states.png
diff --git a/docs/en/diagrams/run_states.xml b/docs/en/diagrams/run_states.xml
@@ -1 +1 @@
-<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36" version="5.7.1.3" editor="www.draw.io" type="device"><diagram>7Vttk5o6FP41frRjEkD8qK7bOrPXu7PbTtv7DSEqt0i8iLvaX38DBCQvUFRA29HOdMkhJCHnOc95MXbQeL3/GFib1V/EwV4H9px9Bz10IAQa6tE/keTAJANNSyTLwHWY7Ch4dX9iJmQPLneug7dcx5AQL3Q3vNAmvo/tkJNZQUDe+W4L4vGzbqwllgSvtuXJ0q+uE64SqQmNo/wTdperdGZgDJI7c8v+sQzIzmfzdSBaxJ/k9tpKx2Ivul1ZDnnPidCkg8YBIWFytd6PsRdtbrptyXOPBXezdQfYDys9wPTyZnk7nC45Xlh4SDfjfeWG+HVj2VH7nWq8g0arcO3RFqCXnjXH3ih77zHxSEBv+cSn/UfbMCA/cCqk22HEn+xOur30zUcL1/NyPRd69C+SEz9kGAGQtXP9evGHyi3PXfpUZtOXx/TmiL0bDkK8L9wgkG07xTMmaxwGB9plzyOSIbk7YO33IywMjclWOUhoaUeLQXGZDX1UB71gGlFrB0rKmc6mn6fDp+k/09lHSVH0YWog0a7XrDLbxPNFFZU5FjYX9pVVhgacygCUVZbJ8ioza9AYkjT28mU2uyurWFk983raksnvefjlddKarhxjbujVuHCxgPa1daX1IaerNlWl/9pPYd8ZRr6ftsgG+59Xrs9rR9r/bLf4/Ucn7DPduuDwjQp7H/S0+Z3Nhx0aVLD1kSBckSXxLW9ylI7sXfCGnWx5VsDNSV9IaD660QY9xEtOI4eoYZO1a7PrZF+iucvVTEMqK1ji1F+pNZ9Tra7QbCoLsGeF7hs/o0rdbIZn4tK1HIEFeWABQ0DMluwCG7On8uGMMJDOj9MFwjjJG0vjUNhYh1y3TdRhW7xeHanXe8RyMuIR2dmWVgK7catg37thDuu09Z2BLjMDkDcC1q9JM6iO9gRDHPHnDQDAcj+F+EAQDEyJ/MospLoxFM50qjGIA6EUtQ1bQxfWaw19yRq+DmkU3GJM9Zv5aSEA7hot+umUcW+Puwocda9phlKTJjibu/oyd5VTl65zcNBMGQ71MFcXAW4meK4bBz0ewRq81I9z8D2NfgC4eUS37HNTRIN8EBBPex6ioYxoVIrovsHDQ1GUqQfRGU2mLlQ7F9HCQPDiyPQSRMt1pbtHLfeoQpWiXZcqF5VuhIAKPdvVnO15BAROZiAN8hSEUEMMpAOhPmbq5zGQgYSBkDBQqwwkl3Meh9Onp8lDaww0N3VNl/GvYiDTxldnICB8EaGK4ppjILkg8TidTV8/3QvblV0Gna1Fhck588Pfs/YK2yaco2pf8jk6Nh3txnTVrnGZt+rer58xw3pSZqCq9+mlkDCMXyKimRTD6GnnOXhxoMuT5oJ5+sI8fPH71P4XlwfB4Fbt53cOj/Om0i+1lIFQbQSK3KgeUymc6VRTEQcSl9JmKJxa6e3B9/r0Xw/7IwX5G6WQ1iBfMs1S8NohrQmRB0RnQhoZfW6gLNysmf2RoQ5ri9dV2v9i9oc3W529jomUWe2ZwZOhsJ9ylyDaj9Zryn4keInH7irbT19IAa7qE+SK34QCOKAiYlPYYAniNPcJyzDNErV88sVEaT7l4UU0QpRHubblDZl47TqOV5QglmeFeUvRSiwl7sdeJbXmi0olZkEgnEPfQIE+MV4+68SmJrPPaUQQ72TWyin0aPP9EqPvS6eQYmZJ+S9L2Kksf5hIwT4KyhRIiGeof3EYHpjA2oWEio6v+0TIpkGyPY/ZVJFBUd238gmnykhRnWgzvMgGHfeNg5Dx3y46Dz6KjLzL7HVIe8Qmm92lV0v2Nx5lu7H8VPayo5e9Z3eDPZcCgPWgS8x3yonjFaTS2qkmK938CWTTE5MSTcE2oCG2keuyE5/slqsYsAzq1GdEyg9XOIZAsNtG+sSUcoIPVMnWOtpcf77d5CCQ0//Ud6nefrr+kq7mBcdM0YkWzz+ZDJ/8H0RoSwaaB3d0XYQuwZXJ2IL9EwOpyuCSa8jNEdTGi6KoOy3VBRxtAHlaUiDHaCoGUhW0GwOOtdveHVqdyDF55ID0+FgbyJFLuePhbDy5fy9c2dBb/eoK3WztstHiSy0lFi7pGJTqOCtqpDruyzqu6bSJ8AMKTawiVv4hBoDqJV+jnIJUNcKmHNI2pJnulf3Rn1PL0Q0BR4paTk3eiDaPv7tOUHb8dTua/A8=</diagram></mxfile>
+<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36" version="6.5.8" editor="www.draw.io" type="device"><diagram name="Page-1">7Vtdl6I4EP01PrpHEkB8VNvudc+sO2d75szMviFEZQeJi9jq/PoNkAD5wAYVtE+3/dCkEpKQulV1U4EOHK8PT6G9Wf2JXeR3QM89dOBDBwBNByb5F0uOVGKZRipZhp5LZbng2fuFqLBHpTvPRVuuYYSxH3kbXujgIEBOxMnsMMR7vtkC+/yoG3uJJMGzY/uy9JvnRqtUarHniuW/I2+5YiNr5iCtmdvOz2WIdwEdrwPgIvml1Wub9UUfdLuyXbwviOCkA8chxlF6tT6MkR8vLlu29L7Hktps3iEKoko36OkdL7a/Q2zKycSiI1uM/cqL0PPGduLynmi8A0eraO2TkkYufXuO/FH23GPs45BUBTgg7UfbKMQ/EROS5TCTX1bDlpc8+Wjh+X6h5cKI/2I5DiKKEQ3QcqFdL/kRue17y4DIHPLwiFSO5NWgC/SCwggdCiK6Ok8Ir1EUHkmTA49IiuTugJb3OSxMncpWBUjorKFNobjMus7VQS6oRtTaAZJyprPpl+nw0/Sf6exJUhS5mRhIvOpXVpljofmiispcG1kL58YqgwNOZRqQVZbJiiqzrqAxKGns76+z2YeyypXVs26nLdn5fR5+fZ60pivXnJtGNV+4WADn1rrS+4DTVZuqMl6PUyhwh3HsJyW8QcGXlRfw2pHWP1stfv1hjXUmqxkevxNh7zeDFX/Q8ZBLSAWdHw6jFV7iwPYnuXTk7MIX5GbTs0NuTPJAQvHRixfoIZkyYw5xwcFrz6HXpYom3S8RC0+pKJ7hSc0XVGsoNMtkIfLtyHvh2ZNK3XSEz9gjk8uBBfkoq5kCYrZ4FzqI3lWkM0JHBg/Qrib0ky6B1A+BjX0sNNvEDbbl8zUgUM43x3LaY47sbEkrgd28V7AfvKiAdVL6QUGXmYFWNALarkkzKEV7ChkO7UUD0EBFC2BxSoTowJKc3ykLqW4MpSPVNQaxI8hQ27A1dMF1raEvWcO3IWHBLXKqNxanBQLcNVuM08zj3p/vKgnUvaY9lNppalV9V1/2XTVdl2FwcNAtGQ7X8VxdqHEjgXPDuNbjEayDS+M4B9967gfKe7oOMH2ySqM5uVjGF17gxdP/A89ZFek1q5UMgNhxxCM+RFvvlz1PGsSgoTMnrY1Rx3hQOYrYH3iO7Q9pxdpz3QSrJc4tT0WxGUkeJUuo0Zl0MorPgbTXUcLtQhIIBeomdIAXiy2KLtQl6/SOvVPL/Il5J61I6JJhK3knIHsnWM879U3e1BUJtut4pyzkMTqkn+udhI7AxbuMSxAt5wg/2NFpdiRknNqlR6pgchcOqJSl3Iw4VXJA2uUeKDuuyvZJDXkgQxNynZZxngcyodARFDpqlR+pjpAEfpQo/v0QJHhdgpRRIr0JSiRnVh+H00+Th9bix9wydEP2Xqr4YTno5vFDE44EVfup5uKHnBp8nM4+DgRrRXwyWosak9NXD3/N2jtjssAcVjtvdw1kufqd6apd67JeD2WIULOQtMEOoTaE2VQJZ+814QXOynhpqnS9UY/TmearKGpmV2n2hCB97q7y8pxXyTh9YRz+7Kpu+4uz+9pAYXN3YT9vaEdUNJV+PUsZCIcFmmI7fB1TKR2prqmIHYlTaXX3I+dfpJARoP372fsM1Gh7A8lh9jinVLnwiDXH9lldn+81+J8V+6Ei9Jv1HJoO+POuLOd2dYemC1wVwDMdGjT7XEfZBuXKsR+a6o1Q+bxOtr849oO7PY65jYmcstpK5sNshbOfmoRAtB+915T9SPAS35mubD99YdN4S0bA3jYqYrgenJLInJUKUM+R0z8Bnb70ImKCT2ZFWaKAyIrvEyowrDA8Aco8zv9FUXSkAnsXYSLKH/cTxpsGTbbUPl7F/YXUhGwuefCde674akclKD4Ho3JSinEZ13vhwGv+t4s/RhnFtLRLeeaQtPDRIsprc/aT9rLd2AGTbfzYyDKmVKwqiJNxK1NiHkEU0sV8FhVVJ8aqrNvpVFsRmfoJZCbt6MMoPtCp/xq2xe/Iu7q8YzMVDlpMKJz1RUp5hqwB4Ni7LfpAzhWRYwIOOaq9fmPIkfM84+FsPPk4aSpX14BXV6u5cFhhN7yNSEi/951wo1T+HMLOvco5qEfOM4rMINFvKltnCN9S6OKetPI3GRpQT7kFck6K+be0afP8i2U4+R8=</diagram></mxfile>
diff --git a/docs/en/extra.css b/docs/en/extra.css
diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
@@ -1,15 +1,29 @@
+docs_dir : en
 site_name: Pirus
 pages:
 - Home: index.md
-- Installation : installation_guide.md
-- About: about.md
+- User guide : user/welcom.md
+  - Installation : user/installation_guide.md
 - Developer Guide :  dev/welcom.md
+  - Architecture : dev/archi.md
   - Model : dev/model.md
+    - File : dev/model/file.md
+    - Pipeline : dev/model/pipeline.md
+    - Job : dev/model/job.md
+  - Core : dev/core.md
+    - File Manager : dev/core/filemanager.md
+    - Pipeline Manager : dev/core/pipelinemanager.md
+    - Job Manager : dev/core/jobmanager.md
+  - Container managers : dev/core/containers.md
+    - LXD : dev/core/containers/lxd.md
   - Api Rest : dev/restapi.md
+    - TUS : dev/rest_api/tus.md
+    - File : dev/rest_api/file.md
+    - Pipeline : dev/rest_api/pipeline.md
+    - Job : dev/rest_api/job.md
   - Api Cli : dev/cliapi.md
+- About: about.md
 theme: readthedocs
-extra_css: 
- - extra.css
 markdown_extensions:
  - extra
  - nl2br