From 9464645f4fd4de947093e3738d34343e4cbd23b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Barthe=CC=81lemy=20de=20Mazenod?= Date: Wed, 24 Apr 2019 12:39:47 +0100 Subject: [PATCH] new pages --- doc/child-object-creation.md | 33 ++++++++++++++++++++++ doc/object-creation.md | 53 ++++++++++++++++++++++++++++++++++++ doc/object-edit.md | 27 ++++++++++++++++++ 3 files changed, 113 insertions(+) create mode 100644 doc/child-object-creation.md create mode 100644 doc/object-creation.md create mode 100644 doc/object-edit.md diff --git a/doc/child-object-creation.md b/doc/child-object-creation.md new file mode 100644 index 000000000..c14166b39 --- /dev/null +++ b/doc/child-object-creation.md @@ -0,0 +1,33 @@ +# Admin object's management - create a child object + +## Usage +> Objects of the Admin can be configured : +> * By setting particular **attributes** to the object +> * By associating **children** to the object +> +> Children can be added, deleted, reordered in the list. Also, it's possible to configure it in a special way for the parent object, by setting children attributes for all the children. +> +> This documentation explains how to associate a child to a parent object. + +### Create a new object for your child in the admin +> Information is available for object's creation: [Modular step management](https://github.com/01-edu/public/blob/master/doc/object-creation.md) + +### Add this new object as a child of your parent's object + +#### 1. Edit the parent object +Capture d’écran 2019-04-22 à 19 24 23 +Capture d’écran 2019-04-22 à 19 24 10 + +#### 2. Go to *Children* > *Add a child* +![add child to parent object](https://user-images.githubusercontent.com/35296671/56506977-de50c800-6517-11e9-9c71-d19a1ec4e5cd.png) + +#### 3. Set up the new child: +* Enter its name in the input "Add a child name" +* Select your step object in the select input +* Click on "ADD" + +> Your step is then related to its parent. You can see it in the *Children* section of the parent's object. There, you can now: +> * Delete the child from its parent (the actual object of your child will not be deleted). +> * Reorder it in the children's list, by dragging it to the place you want. +> * Go to update its settings by clicking on the eye of its reference (it will redirect you to the actual object of your step). +Capture d’écran 2019-04-22 à 19 51 12 diff --git a/doc/object-creation.md b/doc/object-creation.md new file mode 100644 index 000000000..943294850 --- /dev/null +++ b/doc/object-creation.md @@ -0,0 +1,53 @@ +# Admin object's management - create an object + +## Usage +> Elements of the app are managed threw objects in *Admin*. + +> Objects of the Admin are first created and defined: +> * By their **title**, +> * By their **type**. + +> Then it can be configured threw: +> * Attributes, +> * Children. + +> This documentation explains how to create an object. + +### Create a new object in the admin +> (in *Admin* > *Add new object*) + +Capture d’écran 2019-04-22 à 15 57 37 +Capture d’écran 2019-04-22 à 15 58 21 + + +* The **title** of your object will be the title displayed to your candidates. Use an intellegible title for your user. + > NB: you can always edit it in the *Admin* + +* The **type** depends on the nature of your object: + * **Campus** is used to declare a school. + * Examples: *Alem*, *Madeira*, etc. + * Campus can contains cursus: *Alem* contains for example *01-classical* and *Piscine Go*. + * **Cursus** is used to declare a course. + * Examples: *01-classical*, *Piscine Go*, etc. + * Cursuses can contains cursuses: the main cursus *01-classical*, for example, contains cursuses like *Piscine Go*, but also all the branches that the student have access to, as *Web*, *Security*, *Algorythm*, *Design*, etc. + * Cursuses can contains quests: *Piscine Go* of *01-classical* contains quests like *Quest 1* or *Quest 2*. + * **Quest** is used to declare a project. + * Examples: *Quest 1*, *Quest 2*, etc. + * Quest contains exercises: *Quest 1* of *Piscine Go* contains exercises like *printalphabet* or *printcomb*. + * Exercise is used to declare exercises + * Examples: *printalphabet*, *printcomb*, *atoi*, etc. + * Exercises doesn't contains any children. + * Signup is used to declare steps of the registration. + * Examples: *Using our services*, *Tell us more about you*, etc. + * One major object *Sign up* contains all the sign up's modular steps : *Using our services*, *Tell us more about you*, etc. + * Onbaording is used to declare steps of the onbaording. + * Examples: *Toad*, *Administration*, *Additional Informations*, *Chart 01*, etc. + * Three main objects define the major steps of the onboarding : *Toad*, *Administration*, *Piscine*. + * *Administration* contains modular steps: *Additional Informations*, *Chart 01*, etc. + +> The child object is then available in the *Admin*. It can be found in the section of its type or thanks to the search bar of the cursus object's page. + +> More information is available: +> * for setting attributes of an object: (soon available) +> * for setting children of an object: [Child object creation](https://github.com/01-edu/public/blob/master/doc/child-object-creation.md) +> * for creation of modular steps in Sign up and onboarding's Administration object: [Modular step management](https://github.com/01-edu/public/blob/master/doc/modular-steps-management.md) diff --git a/doc/object-edit.md b/doc/object-edit.md new file mode 100644 index 000000000..339e197c7 --- /dev/null +++ b/doc/object-edit.md @@ -0,0 +1,27 @@ +# Objects + +> Allow you to create, manage and organize your pedagical and onboarding content. + +## Definition + +An Object is an highly customizable element, which can be use in many situations. We use it to compose cursuses and onboarding processes. +Objects can be associated together and then share a vertical or horizontal relationship, which allows to build complex structure of multiple objects. + +It structure can be visualized in two parts. The first one is the definition of the object itself and attributes, called `attrs`. The second part is the definition of minor relationships, called `children` and attributes applied to them, called `childrenAttrs`. + +This is the minimal structure of an object: + +- name +- type (`organisation`, `campus`, `onboarding`, `cursus`, `quest`, `exercise`) +- status (`draft`, `online`, `offline`) +- attrs {} +- childrenAttrs {} +- children {} + +## Browse Objects: + +To access your Objects, go to the admin dashboard and then click on the _manage object_ link within the "Object" card. + +![go-to-objects](https://user-images.githubusercontent.com/15313830/56653756-46bdb780-6686-11e9-98ba-18e382987e9c.png) + +Objects are sorted by type in different sections. This page offer a search bar that allow you query the objects by name. In the top-right corner, click the _add a new object_ button to create a new object. Fill a name, select a type and click _create_ to validate your creation. You will be redirected to the Object Edition page (document is here).