From 7b23d403480e7b58c0b17a8beda3119e00a7ae35 Mon Sep 17 00:00:00 2001
From: Alice Poggioli <alice.poggioli@paca.happy-dev.fr>
Date: Tue, 1 Sep 2020 12:07:42 +0200
Subject: [PATCH] remove demonstration for get stated
---
source/import_documentation/get-started.rst | 74 ++++++++++++++++++++-
source/index.rst | 40 -----------
2 files changed, 72 insertions(+), 42 deletions(-)
diff --git a/source/import_documentation/get-started.rst b/source/import_documentation/get-started.rst
index b5171a5..4d85c85 100644
--- a/source/import_documentation/get-started.rst
+++ b/source/import_documentation/get-started.rst
@@ -1,9 +1,33 @@
Getting Started
****************
+Interoperability
+================
+What does it mean ?
+
+It means that any front can use any data sources from any back because it communicates with each other with a universal API.
+
+.. figure:: ../_static/images/import_documentation/Centralized-Vs-Decentralized.png
+ :alt: What is interoperability ?
+
+So you can learn how to use the back and the front independently.
+
+.. note::
+
+ To see how our API is structured, have a look to our `SOLID Introduction <https://docs.startinblox.com/import_documentation/Solid-introduction>`__
+
With the Front
==============
+If you are familiar with React or VusJS, learning how to use Startin'blox is going to be so easy for you. It's even easier.
+
+So why using Startin'blox instead of React ?
+-------------------------------------------
+Because it allows you to easily grasp the SOLID standards that allow the universalization of APIs and to be more than up to date on the latest web component standards.
+
+How to set up the technology ?
+----------------------------
+
To start, simply import the core in your head tag of a simple html file :
.. code-block:: html
@@ -11,9 +35,55 @@ To start, simply import the core in your head tag of a simple html file :
<!-- ... Import the core ... -->
<script type="module" src="https://unpkg.com/@startinblox/core"></script>
-It enables you to use Startin’blox technology and all the main components from the core of the framework.
+Base Components
+~~~~~~~~~~~~~~~
+It enables you to use Startin’blox technology and all the base components from the core of the framework like `Solid-display <https://docs.startinblox.com/import_documentation/Components/SiB-Display.html>`__, that displays datas or `Solid-form <https://docs.startinblox.com/import_documentation/Components/SiB-Form.html>`__ that propose a form to post data.
+
+.. code-block:: html
+
+ <solid-display
+ data-src="https://apiprod.happy-dev.fr/collectives/"
+ fields="name, email"
+ ></solid-display>
+
+.. note:: Notes the data-src attribute
+
+ You will find it in almost all Startin'blox components. It is this attribute that hosts the data source you want to use within this component. You can go to the url (`https://apiprod.happy-dev.fr/collectives/<https://apiprod.happy-dev.fr/collectives/>`__ ) to see what the API looks like.
+
+
+Extend Components
+~~~~~~~~~~~~~~~~~
+Some usefull components aren't in the core because in order not to make it too heavy and to keep its modularity. It's the case for `Solid-Router <https://docs.startinblox.com/import_documentation/Components/SiB-Router.html>`__ or `Solid Auth <https://docs.startinblox.com/import_documentation/Components/Solid-Auth.html>`__ for example.
+To use them, you have to import them independently.
+
+.. code-block:: html
+
+ <!-- ... Import the core ... -->
+ <script type="module" src="https://unpkg.com/@startinblox/core"></script>
+ <script type="module" src="https://unpkg.com/@startinblox/router@latest"></script>
+
+Create a components
+~~~~~~~~~~~~~~~~~~
+Developing a component can be overly easy. We offer you a tutorial to familiarize you with the technology. It is quick and relatively simple :)
+
+`Try the tutorial <https://docs.startinblox.com/import_documentation/How-to-make-components.html>`__ !
+
+Play with the technology
+-------------------------
+
+Try the demonstration
+~~~~~~~~~~~~~~~~~~~~~~~
+You can play with `the demo <https://startinblox.com/fr/technology#demo/>`__ on our website.
+
+Some public sources
+~~~~~~~~~~~~~~~~~~~~~~~
+To make your tests with Startin'blox, here is some publics read only data sources :
+
+* `The Happy Dev event <https://apiprod.happy-dev.fr/futureevents/>`__.
+* `The Happy Dev collectifs <https://apiprod.happy-dev.fr/collectives/>`__.
+* `The Startin'blox features <https://api.startinblox.com/features/>`__.
+
-Jump to the `demonstration <https://docs.startinblox.com/import_documentation/sib-demo.html#demonstration>`__ to go forward !
With the back
diff --git a/source/index.rst b/source/index.rst
index fc865e9..6ac8ae6 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -17,29 +17,12 @@ Welcome to Startinblox's documentation!
:maxdepth: 2
:caption: How it work:
- import_documentation/sib-demo
import_documentation/How-to-make-components
import_documentation/install-sib-server
import_documentation/develop-sib-ldp-packages
import_documentation/server-architecture
import_documentation/frequent-errors
-.. import_documentation/core-framework-architecture
-
-
-.. import_documentation/component-architecture
-.. import_documentation/widgets
-.. import_documentation/server-packages
-
-.. .. toctree::
-.. :maxdepth: 2
-.. :caption: Advanced features:
-
-.. import_documentation/List-Post-processing
-.. import_documentation/Events
-.. import_documentation/Helpers-functions
-.. import_documentation/Mixin-API
-
.. toctree::
:maxdepth: 2
:caption: Base components:
@@ -89,26 +72,3 @@ Welcome to Startinblox's documentation!
import_documentation/Helpers-functions
import_documentation/Store-doc
-
-
-.. toctree::
- :maxdepth: 2
- :caption: Extended Components:
-
- import_documentation/Components/SiB-Router
- import_documentation/Components/SiB-Auth
- import_documentation/Components/SiB-Notification
- import_documentation/Components/Sib-Badge
-
-.. toctree::
- :maxdepth: 2
- :caption: Community Components:
-
- import_documentation/Components/SiB-Dashboard
- import_documentation/Components/SiB-Chat
- import_documentation/Components/SiB-Invoicing
- import_documentation/Components/Sib-Directory
- import_documentation/Components/SiB-Like
- import_documentation/Components/SiB-Job-Board
- import_documentation/Components/SiB-Conversation
- import_documentation/Components/Sib-Editor
\ No newline at end of file
--
GitLab