From ce692a305c4fc28b6f07d21c15bc9217c7cfcc21 Mon Sep 17 00:00:00 2001 From: Alice <alice.poggioli@hotmail.fr> Date: Thu, 30 Apr 2020 14:08:42 +0200 Subject: [PATCH] Add packages install --- .../component-architecture.rst | 0 .../develop-sib-ldp-packages.rst | 36 +++++++++++++++++++ source/import_documentation/get-started.rst | 3 +- source/import_documentation/sib-demo.rst | 3 +- source/index.rst | 1 + 5 files changed, 39 insertions(+), 4 deletions(-) create mode 100644 source/import_documentation/component-architecture.rst create mode 100644 source/import_documentation/develop-sib-ldp-packages.rst diff --git a/source/import_documentation/component-architecture.rst b/source/import_documentation/component-architecture.rst new file mode 100644 index 0000000..e69de29 diff --git a/source/import_documentation/develop-sib-ldp-packages.rst b/source/import_documentation/develop-sib-ldp-packages.rst new file mode 100644 index 0000000..41027e0 --- /dev/null +++ b/source/import_documentation/develop-sib-ldp-packages.rst @@ -0,0 +1,36 @@ +Develop SIB server packages +########################## + +Requirements +============= + +A `SIB server <https://docs.startinblox.com/import_documentation/install-sib-server.html#how-to-install-a-sib-server>`__ in development mode + + +Create your package +==================== +From the project directory (the folder where the manage.py resides) create a new package structure: + +.. code-block:: bash + + sib startpackage mypack + +Add your package to the packages.yml: + +.. code-block:: yml + + ldppackages: + mypack: mypack + +Then initiate your server backend: + +.. code-block:: yml + + sib install sib_server + +Note: It is important to run this command from the project directory in order for the manager to find your package. +Finally, you can run your server as usual to see your new package's data. + +.. warning:: + + The section should be improve \ No newline at end of file diff --git a/source/import_documentation/get-started.rst b/source/import_documentation/get-started.rst index cf8d543..015e39f 100644 --- a/source/import_documentation/get-started.rst +++ b/source/import_documentation/get-started.rst @@ -13,8 +13,7 @@ To start, simply import the core in your head tag of a simple html file : It enables you to use Startin’blox technology and all the main components from the core of the framework. -Jump to the `demonstration <https://docs.startinblox.com/import_documentation/sib-demo.html#demonstration ->`__ to go forward ! +Jump to the `demonstration <https://docs.startinblox.com/import_documentation/sib-demo.html#demonstration>`__ to go forward ! With the back diff --git a/source/import_documentation/sib-demo.rst b/source/import_documentation/sib-demo.rst index a3956e5..c58baa1 100644 --- a/source/import_documentation/sib-demo.rst +++ b/source/import_documentation/sib-demo.rst @@ -30,8 +30,7 @@ To try the framework, you can play with Have a look on our API ======================= -To see how our API is structured, have a look to our `SOLID Introduction <https://docs.startinblox.com/import_documentation/Solid-introduction ->`__ +To see how our API is structured, have a look to our `SOLID Introduction <https://docs.startinblox.com/import_documentation/Solid-introduction>`__ Some public sources -------------------- diff --git a/source/index.rst b/source/index.rst index 193d4b8..61cd6a6 100644 --- a/source/index.rst +++ b/source/index.rst @@ -19,6 +19,7 @@ Welcome to Startinblox's documentation! import_documentation/sib-demo import_documentation/install-sib-server + import_documentation/develop-sib-ldp-packages import_documentation/server-architecture import_documentation/core-framework-architecture -- GitLab