mirror of https://github.com/01-edu/public.git
Merge branch 'documentation' into doc-object-edit
This commit is contained in:
commit
4c5b90253d
|
@ -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
|
||||
<img width="640" alt="Capture d’écran 2019-04-22 à 19 24 23" src="https://user-images.githubusercontent.com/35296671/56517407-cb98bc00-6534-11e9-98d6-a2b1c0193a38.png">
|
||||
<img width="640" alt="Capture d’écran 2019-04-22 à 19 24 10" src="https://user-images.githubusercontent.com/35296671/56517421-d0f60680-6534-11e9-86ef-97fb9e59786e.png">
|
||||
|
||||
#### 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).
|
||||
<img width="1229" alt="Capture d’écran 2019-04-22 à 19 51 12" src="https://user-images.githubusercontent.com/35296671/56518936-a1e19400-6538-11e9-81c7-520ffd365cff.png">
|
|
@ -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: [Object creation](https://github.com/01-edu/public/blob/master/doc/object-creation.md)
|
||||
|
||||
<img width="664" alt="Capture d’écran 2019-04-22 à 15 57 37" src="https://user-images.githubusercontent.com/35296671/56507169-6505a500-6518-11e9-89bb-04c7fd9b41ca.png">
|
||||
<img width="450" alt="Capture d’écran 2019-04-22 à 15 58 21" src="https://user-images.githubusercontent.com/35296671/56507180-6afb8600-6518-11e9-97a5-4dcff8f0a069.png">
|
||||
|
||||
|
||||
* 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*)
|
||||
<img width="640" alt="Capture d’écran 2019-04-22 à 19 24 23" src="https://user-images.githubusercontent.com/35296671/56517407-cb98bc00-6534-11e9-98d6-a2b1c0193a38.png">
|
||||
<img width="640" alt="Capture d’écran 2019-04-22 à 19 24 10" src="https://user-images.githubusercontent.com/35296671/56517421-d0f60680-6534-11e9-86ef-97fb9e59786e.png">
|
||||
* Edit the parent object: *Sign up* or *Administration*
|
||||
|
||||
#### 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"
|
||||
|
||||
> 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).
|
||||
<img width="1229" alt="Capture d’écran 2019-04-22 à 19 51 12" src="https://user-images.githubusercontent.com/35296671/56518936-a1e19400-6538-11e9-81c7-520ffd365cff.png">
|
||||
> 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:
|
||||
|
|
|
@ -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*)
|
||||
|
||||
<img width="664" alt="Capture d’écran 2019-04-22 à 15 57 37" src="https://user-images.githubusercontent.com/35296671/56507169-6505a500-6518-11e9-89bb-04c7fd9b41ca.png">
|
||||
<img width="450" alt="Capture d’écran 2019-04-22 à 15 58 21" src="https://user-images.githubusercontent.com/35296671/56507180-6afb8600-6518-11e9-97a5-4dcff8f0a069.png">
|
||||
|
||||
|
||||
* 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)
|
Loading…
Reference in New Issue