From b10670c0cbbcfdd487790069732fd1e685b76330 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/object-edit.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 doc/object-edit.md diff --git a/doc/object-edit.md b/doc/object-edit.md new file mode 100644 index 00000000..339e197c --- /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).