Skip to content
Snippets Groups Projects
Commit f7ec563f authored by Alice Poggioli's avatar Alice Poggioli
Browse files

Merge branch 'master' of git.startinblox.com:documentation/doc

parents a0d245b7 863f4d7f
No related branches found
No related tags found
No related merge requests found
Pipeline #5698 passed
......@@ -4,12 +4,13 @@ This is the repository of [the main documentation of Startin'blox](https://docs.
We use [Sphinx](https://www.sphinx-doc.org/en/master/) to manage the documentation and we use [Restructured Text](https://docutils.sourceforge.io/rst.html) to write it.
[Why we've chosen Restructured Text](https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/)
## How to update it
* Clone the repository
* Find the file use when to update
* Make a Merge Request :)
* Find the file you want to update and make your change
* Make a Merge Request and assign Alice Poggioli :)
## You get trouble ?
......
......@@ -13,7 +13,7 @@ Thanks to W3C and `the work of Tim Berners-Lee <https://solid.mit.edu/>`__, an a
**Startin'blox has set itself the mission of precipitating the advent of this new type of digital platform.**
We've build a solution to make the creation of federated and interoperable applications as accessible as possible.
We've built a solution to make the creation of federated and interoperable applications as accessible as possible.
.. figure:: ../_static/images/import_documentation/federation.png
:alt: Federation concept
......@@ -30,26 +30,26 @@ Startin'blox is composed of :
A front framework
..................
It can be import by a simple script in a html file and provide you basics functionalities like making a form, display datas, a map, a calendar etc..
It can be imported by a simple script in a html file and provides you basics functionalities like making a form, displaying data, a map, a calendar etc..
In the Startin'blox philosophy, the logic of the data processing is done on the front side.
Extended features components
............................
Components are web components that conrespond to functionalities that you can easily add to existing applications. Startin'blox creates components according to its uses but in the future we encourage the development of community components.
Components are web components that correspond to functionalities that you can easily add to existing applications. Startin'blox creates components according to its uses but in the future we encourage the development of community components.
For example, Sib-Directory provide you a skills directory of your users.
For example, Sib-Directory provides you with a user directory that includes user skills.
.. figure:: ../_static/images/import_documentation/Components.png
:alt: Component example
Each components treat a specific shape of data. The validation of this shape is made on the server side.
Each component treats a specific shape of data. The validation of this shape is made on the server side.
A server solution
.................
We offer a server solution based on the `Django framework <https://www.djangoproject.com/>`__ and adapted to be compatible with the Linked datas platform conventions, named DjangoLDP.
It is a simple architecture on which we can add LDP packages, corresponding to the different components used. Those are the ones that will do the work of validating the data of the application.
It is a simple architecture on which we can add LDP packages, corresponding to the different components used. Those are the ones that will do the work of validating the application data.
.. figure:: ../_static/images/import_documentation/Overview-server.png
:alt: Server overview
......@@ -58,7 +58,7 @@ It is a simple architecture on which we can add LDP packages, corresponding to t
The federation is done on client side.
To sum up, the solution is quite simple to summarize:
The solution can be summarized as follows:
.. figure:: ../_static/images/import_documentation/Overview-of-SiB.png
:alt: SiB overview
......@@ -70,7 +70,7 @@ Overview of the Framework
The section should be improve
Here is a very quick presentation :
Here is a brief presentation :
.. figure:: ../_static/images/import_documentation/Framework-Overview.png
:alt: Framework Overview
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment