From e65a5c19229bda1f966336c637b9b4ba61af2748 Mon Sep 17 00:00:00 2001 From: Louise Foussat Date: Wed, 24 Apr 2019 12:01:24 +0100 Subject: [PATCH 1/3] cutting the documentation in 3 files : object-creation, child-object-creation, modular-step-management --- doc/child-object-creation.md | 33 ++++++++++++++++++++ doc/modular-steps-management.md | 30 ++++--------------- doc/object-creation.md | 53 +++++++++++++++++++++++++++++++++ 3 files changed, 91 insertions(+), 25 deletions(-) create mode 100644 doc/child-object-creation.md create mode 100644 doc/object-creation.md diff --git a/doc/child-object-creation.md b/doc/child-object-creation.md new file mode 100644 index 00000000..c14166b3 --- /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/modular-steps-management.md b/doc/modular-steps-management.md index 65c5a593..cd2ac6ff 100644 --- a/doc/modular-steps-management.md +++ b/doc/modular-steps-management.md @@ -9,40 +9,20 @@ > > This documentation explains how to manage these steps. -## Creating a step: +## Create your step child object ### Create a new object for your step in the admin -> (in *Admin* > *Add new object*) +> Information is available for object's creation: [Modular step management](https://github.com/01-edu/public/blob/master/doc/object-creation.md) -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 (for the step you are creating). Use an intellegible title for your user. - > NB: you can always edit it in the *Admin* -* This object must have the same type as its future parent object ("signup" or "onboarding"). +* This object must have the same type as its future parent object (*signup* or *onboarding*). > Your step is then available in the *Admin*. You can find it in the section of its type (*SignUp* or *Onboarding*) or thanks to the search bar of the cursus object's page. ### Add this new object as a child of your parent's object -#### 1. Edit the parent object (*Sign up* or *Administration*) -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 major 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" +* Edit the parent object: *Sign up* or *Administration* -> 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 step as a child of its parent (the actual object of your step 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 +> Information is available for object's creation: [Modular step management](https://github.com/01-edu/public/blob/master/doc/child-object-creation.md) ## Settings for a `form` step > In the step object you have created, 2 attributes must be filled: diff --git a/doc/object-creation.md b/doc/object-creation.md new file mode 100644 index 00000000..cdf1b915 --- /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) From b0c94e579a08d5f3fe3ca8edbc85eabde7c6b461 Mon Sep 17 00:00:00 2001 From: lfoussat <35296671+lfoussat@users.noreply.github.com> Date: Wed, 24 Apr 2019 12:03:41 +0100 Subject: [PATCH 2/3] fix display of quotes --- doc/object-creation.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/object-creation.md b/doc/object-creation.md index cdf1b915..94329485 100644 --- a/doc/object-creation.md +++ b/doc/object-creation.md @@ -4,13 +4,13 @@ > 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**. +> * By their **title**, +> * By their **type**. > Then it can be configured threw: - * Attributes, - * Children. -> +> * Attributes, +> * Children. + > This documentation explains how to create an object. ### Create a new object in the admin @@ -48,6 +48,6 @@ > 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) +> * 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) From 75741ba30c0257515045297a470ac7e57db6d8dc Mon Sep 17 00:00:00 2001 From: lfoussat <35296671+lfoussat@users.noreply.github.com> Date: Wed, 24 Apr 2019 12:09:52 +0100 Subject: [PATCH 3/3] fix link to objectcreation & child object creation --- doc/modular-steps-management.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/modular-steps-management.md b/doc/modular-steps-management.md index cd2ac6ff..1197caca 100644 --- a/doc/modular-steps-management.md +++ b/doc/modular-steps-management.md @@ -11,7 +11,7 @@ ## Create your step child object ### Create a new object for your step 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) +> Information is available for object's creation: [Object creation](https://github.com/01-edu/public/blob/master/doc/object-creation.md) * This object must have the same type as its future parent object (*signup* or *onboarding*). @@ -22,7 +22,7 @@ * Edit the parent object: *Sign up* or *Administration* -> Information is available for object's creation: [Modular step management](https://github.com/01-edu/public/blob/master/doc/child-object-creation.md) +> Information is available for object's creation: [Child object creation](https://github.com/01-edu/public/blob/master/doc/child-object-creation.md) ## Settings for a `form` step > In the step object you have created, 2 attributes must be filled: