diff --git a/source/import_documentation/How-to-make-components.rst b/source/import_documentation/How-to-make-components.rst index 8a336c1cd467f6c3a7575111a8d7d3518e4964bc..d8eaacdd5643e088ff48a3589e07d3cf8b761615 100644 --- a/source/import_documentation/How-to-make-components.rst +++ b/source/import_documentation/How-to-make-components.rst @@ -1,33 +1,34 @@ -How to make components +How to create components ###################### -When you should make a component -================================= -A component is a feature ------------------------ -A component is an application service that can be re-used by multiple organizations. You can think about it as an atomic functionality that can be picked and added by people with no technical skills. +.. note:: + When you should create a component + ================================= + A component is a feature + ----------------------- + A component is an application service that can be re-used by multiple organizations. You can think about it as an atomic functionality that can be picked and added by people with no technical skills. -Developers often build components in order to avoid repeating the same piece of code in multiple places. As a developer, you may wonder why you should create a component when you can implement the same functionality with the same amount of code, just by calling the underlying services. + Developers often build components in order to avoid repeating the same piece of code in multiple places. As a developer, why should you make a component when you can have the same functionality with the same amount of code? -Don't create a component for your technical needs but for the needs of organizations -------------------------------------------------------------------------------------- -Developing with Startin'Blox is an opportunity to shift your perspective regarding who you program for. Instead of thinking just about your own requirements, you're invited to deliver features useful to both your own project and a much broader ecosystem of organizations. + **Because you don't create a component for your technical needs but for the needs of organizations. Our components are high level components. That is to say that it is close to the human understanding of a functionality.** -Example with a FAQ component ---------------------------- -For instance, implementing a collaborative FAQ could be done with few code. Encapsulating them within an FAQ component wouldn't make your code more concise. But it permit you to share the *idea* of a FAQ. + Developing with Startin'Blox is an opportunity to shift your perspective regarding who you program for. Instead of thinking just about your own requirements, you're invited to deliver features useful to both your own project and a much broader ecosystem of organizations. + Example with a FAQ component + --------------------------- + For instance, implementing a collaborative FAQ could be done with few code. Encapsulating them within an FAQ component wouldn't make your code more concise. But it permit you to share the *idea* of a FAQ. -**With components, you share more than code, you share resources for collaboration within and between organizations.** -So, when you develop a new feature, think about who could use it. If it can be useful to others and there's no similar component already available, make a component so that your work will be easily accessed and used by many! + **With components, you share more than code, you share resources for collaboration within and between organizations.** -Other example : ---------------- - * An interactive map - * An agenda - * A job broad - * A skill directory + So, when you develop a new feature, think about who could use it. If it can be useful to others and there's no similar component already available, make a component so that your work will be easily accessed and used by many! + + Other example : + --------------- + * An interactive map + * An agenda + * A job broad + * A skill directory Let's start ============= diff --git a/source/import_documentation/get-started.rst b/source/import_documentation/get-started.rst index 3ab3b1c8ee32d9a5dc48044159872cc7cc90197c..18aaea937de22e0a6151da2a62203d6bf28490b0 100644 --- a/source/import_documentation/get-started.rst +++ b/source/import_documentation/get-started.rst @@ -1,21 +1,5 @@ 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 ============== @@ -23,7 +7,7 @@ If you are familiar with React or VusJS, learning how to use Startin'blox is goi So why using Startin'blox instead of React or VueJS? ------------------------------------------- -Because it allows you to easily grasp the SOLID standards that allow the universalization of APIs, it is also lighter to install and to be more than up to date on the latest web component standards. +Because it allows you to easily grasp the SOLID standards and web components last standards. It is also lighter to install. How to set up the technology ? ---------------------------- @@ -37,7 +21,7 @@ To start, simply import the core in your head tag of a simple html file : 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. +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 data or `Solid-form <https://docs.startinblox.com/import_documentation/Components/SiB-Form.html>`__ that offer a form to post data. .. code-block:: html @@ -49,7 +33,7 @@ It enables you to use Startin’blox technology and all the base components from .. 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. + You will find it in almost all Startin'blox components. It is this attribute that hosts the data source you want to interact with in 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 @@ -65,9 +49,7 @@ To use them, you have to import them independently. 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>`__ ! +`Try the tutorial <https://docs.startinblox.com/import_documentation/How-to-make-components.html>`__, to get in to it! Play with the technology ------------------------- @@ -84,7 +66,9 @@ To make your tests with Startin'blox, here is some publics read only data source * `The Happy Dev collectifs <https://apiprod.happy-dev.fr/collectives/>`__. * `The Startin'blox features <https://api.startinblox.com/features/>`__. +.. 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 back